Hatena Blog Tags
はてなブログ トップ
OpenAPI
このタグでブログを書く

OpenAPI

このタグの解説についてこの解説文は、すでに終了したサービス「はてなキーワード」内で有志のユーザーが作成・編集した内容に基づいています。その正確性や網羅性をはてなが保証するものではありません。問題のある記述を発見した場合には、お問い合わせフォームよりご連絡ください。
きり丸の技術日記•10日前

FastAPIから型定義を出力する

始めに 小ネタ。 FastAPIからopenapi.jsonが出力できるなら、フロントエンドで使用する型定義まで出力する手順を確立したくて記事にします。 なお、フロントエンドはすでに構築されていたこともあり、自動生成した型定義の導入までは行えていません。また、FastAPIから型定義を出力する際にこういう工夫をしています、というコメント募集しています。 環境 FastAPI 0.115.12 openapi-typescript 7.8.0 @openapitools/openapi-generator-cli 2.20.2 実装 OpenAPIファイルの取得 FastAPIの/openapi…

#fastapi#OpenAPI#OpenAPI Generator#openapi-generator-cli

関連ブログ

every Tech Blog•14日前

OpenAPI における null 値の表現の仕方

こんにちは、@きょーです！普段はデリッシュキッチン開発部のバックエンド中心で業務をしています。 はじめに OpenAPI で API 仕様書を書く際、null 値を許容するプロパティの表現方法はバージョンによって異なります。たとえば、ユーザープロフィールのメールアドレスのように「値が存在しない（null）」を許容したいケースはよくありますが、その書き方や推奨される方法は OpenAPI のバージョンごとに変化してきました。 この記事では、OpenAPI 3.0.0 と 3.1.0 それぞれでの null 許容プロパティの書き方や、その背景、なぜ仕様が変わったのか、どちらを使うべきかについて解説…

#APIDocumentation#OpenAPI#OpenAPI Generator
freee Developers Hub•20日前

OpenAPI ではなく TypeSpec を読み書きするスキーマ駆動開発

支出管理開発本部で事業部横断テックリードをしている @ogugu です。 広く複雑で大規模になりつつある支出管理のアーキテクチャについて、以下の連載形式でご紹介していきます。 (本記事) 支出管理におけるTypeSpecを中心にしたスキーマ駆動開発 ソフトウェアアーキテクチャに基づいた自動テスト戦略と実装ガイドライン 支出管理におけるマイクロサービスアーキテクチャの知見 今回は、TypeSpec を中心にしたスキーマ駆動開発をご紹介します。 結論からいうと、筆者は TypeSpec について「OpenAPI からの移行コストや技術的ロックインリスクを伴わず、開発体験を向上する最高のツール」と評…

#Typespec#OpenAPI#Go言語#react#開発生産性
SPIDERPLUS Tech Blog•21日前

hono/zod-openapiで実現するAPI開発実践

🧪 @hono/zod-openapi でAPI開発をネクストレベルに 前回投稿の記事、「TypeScriptとhonoで作るDI実践入門」ではHonoとTypescriptで型安全なDIを実践しました。 techblog.spiderplus.co.jp しかし、前回の実装では以下の課題がありました。 リクエスト/レスポンスの型安全性が不十分 APIドキュメントを手動で管理する必要がある バリデーションロジックが分散してしまう 今回はこの課題に対して、@hono/zod-openapiを導入し解決していきます。 @hono/zod-openapiを導入することで、ZodスキーマからOpenA…

#TypeScript#Zod#OpenAPI#API開発#Hono
弁護士ドットコム株式会社 Creators’ blog•24日前

TypeScript開発者が試すOrval活用術：OpenAPIからMCPサーバーを自動生成しClaudeでAPIを呼び出すまで

🐾 はじめに こんにちは、砂川(@misdo_tabeyo)です。 普段は『弁護士ドットコムLIBRARY』と『BUSINESS LAWYERS LIBRARY』というサービスでフロントエンド開発を担当しています。これらのサービスでは、Orval を利用して OpenAPI からAPIクライアントやZodのバリデーションスキーマを生成しています。 そんなOrvalに最近、Model Context Protocol (MCP) サーバーの生成機能が追加された と知り、早速試してみました。 MCP は LLM（大規模言語モデル）アプリケーションと外部ツール・データソースを接続するための標準プロト…

#TypeScript#Orval#MCP#Claude#OpenAPI
PLAY DEVELOPERS BLOG•1ヶ月前

@nestjs/swagger を活用して NestJS 製 API の仕様書を作る

こんにちは、OTTサービス技術部 開発第1グループの清瀬です。 主にフロントエンドエンジニアを担当しております。 とあるプロダクトで、NestJSを触る機会がありました。 そのプロダクトではAPIドキュメントがなかったので、NestJSのdecoratorを利用してSwaggerSpec(APIドキュメント)を自動生成してみたので、その手順を紹介したいと思います。 そもそもNestJSって? APIドキュメント生成手順 @nestjs/swaggerのdecorator紹介 【Tips】カスタムデコレーターでエラーレスポンスを共通化しよう まとめ そもそもNestJSって? NestJSはNo…

#NestJS#OpenAPI
MicroAd Developers Blog•2ヶ月前

OpenAPIからTypeScriptの型定義を作る: APIファースト開発の効率化

システム開発部新規プロダクト開発ユニット(NDU)の大石です。 NDUはその名の通り、広告事業に関わらない様々な新規事業に関するサービスの開発・立ち上げを担当するユニットです。 新規事業の立ち上げではスピードが重視され、NDU では効率的な開発で迅速なローンチを目標の1つとして開発をしています。 今回はBtoB企業向けの商談獲得ツール「ショウグン」の開発で行ったAPIの型定義の効率化について紹介いたします。 ショウグン OpenAPIとAPIファースト開発 NDUをはじめ、マイクロアドの様々なプロジェクトでOpenAPIを用いたAPIファーストな開発を取り入れており、ショウグンでも採用していま…

#TypeScript#OpenAPI
その手の平は尻もつかめるさ•2ヶ月前

openapi-fetch-genを作った

English article is here: openapi-fetch-gen – Generate TypeScript API client from OpenAPI TypeScript interface definitions created by openapi-typescript - DEV Communitynpm registryにも公開されています。従って以下のようにダウンロード可能です。 npm install @moznion/openapi-fetch-gen これは何 / 背景 OpenAPI 3の仕様からopenapi-ts/openapi-typescr…

#OpenAPI#TypeScript
エキサイト TechBlog.•7ヶ月前

JavaのSpringdocはAPIのリクエストパラメータをどのように認識しているのか？

こんにちは、エキサイト株式会社の平石です。 エキサイトホールディングス Advent Calendar 2024の10日目を担当いたします。 Springdocライブラリを利用することで、簡単にOpenAPI仕様に則ったAPIドキュメントを自動生成することができます。 しかし、このライブラリを使って開発を行う中で、APIのパラメータをどのように認識しているのか少し気になったので、その調査をしてみました。 今回は、その内容をブログとして残したいと思います。 なお、今回紹介するのはspringdoc-openapi v2.7.0での動作であり、今後変更される可能性はありますのでご注意ください。 共…

#OpenAPI#Springdoc#Java#ParameterObject