API のエンドポイントやパラメータ、レスポンスの形をひとつのファイルにまとめて定義します。ここから API ドキュメントの自動生成、クライアントコードの生成、モックサーバーの用意までが機械的に行えます。
API のエンドポイントやパラメータ、レスポンスの形をひとつのファイルにまとめて定義します。ここから API ドキュメントの自動生成、クライアントコードの生成、モックサーバーの用意までが機械的に行えます。
API を提供する側が入出力や認証の形を YAML/JSON で公開する場面で見かけます。Swagger UI などの画面で仕様書として表示され、旧称は Swagger です。
API の仕様を YAML/JSON で書き表す記述形式です。
ドキュメントやコードが仕様書から自動で作れます。
現行版は 3.2.0 で、4.0 はまだ設計段階です。
API ドキュメント生成やコード自動生成の場面で使います。
まずはひとつのエンドポイントを YAML で書いてみます。
JSON Schema、Swagger UI、コード生成。
2026-08 時点の現行版は 3.2.0(2025-09 リリース)。