OpenAPI仕様（おーぷんえーぴーあいしよう）
最終更新：2026/4/25
OpenAPI仕様は、RESTful APIを記述するための標準化されたフォーマットであり、APIの構造と動作を定義する。
別名・同義語 Swagger SpecificationOAS
ポイント
OpenAPI仕様は、SwaggerツールやAPIドキュメント生成ツールとの互換性があり、APIの設計、開発、テストを効率化する。
OpenAPI仕様とは
OpenAPI仕様（旧Swagger Specification）は、RESTful APIを記述するためのオープンスタンダードです。APIの利用方法を機械可読な形式で定義することで、APIの設計、開発、ドキュメント作成、テストを効率化することを目的としています。
OpenAPI仕様の構成要素
OpenAPI仕様は、YAMLまたはJSON形式で記述されます。主な構成要素は以下の通りです。
- Info: APIのタイトル、バージョン、説明などのメタ情報。
- Servers: APIが利用可能なサーバーのURL。
- Paths: APIのエンドポイント（パス）と、それに対応するHTTPメソッド（GET, POST, PUT, DELETEなど）を定義。
- Components: APIで再利用可能なスキーマ、パラメータ、レスポンスなどを定義。
OpenAPI仕様のメリット
- APIの可視化: APIの構造と動作を明確に理解できる。
- ドキュメントの自動生成: OpenAPI仕様から、インタラクティブなAPIドキュメントを自動生成できる。
- コードの自動生成: OpenAPI仕様から、サーバーサイドまたはクライアントサイドのコードを自動生成できる。
- APIのテスト: OpenAPI仕様に基づいて、APIのテストを自動化できる。
- APIの設計の標準化: チーム全体でAPI設計の共通認識を確立できる。
OpenAPI仕様の利用例
OpenAPI仕様は、様々なAPIプラットフォームやツールで利用されています。