OpenAPIとは？
おーぷんえーぴーあい
OpenAPIとはREST APIの仕様を記述するための標準フォーマットで、APIの構造をYAMLまたはJSONで定義します。
OpenAPIは、HTTP APIの仕様を機械可読な形式で記述するための業界標準仕様です。もともとSwaggerという名称で知られていましたが、2016年にLinux Foundationのプロジェクトとして「OpenAPI Specification（OAS）」として標準化されました。現在はバージョン3.xが主流です。
仕様書はYAMLまたはJSON形式で書かれ、エンドポイントのパス・HTTPメソッド・リクエストパラメータ・レスポンスのスキーマ・認証方式などを一か所に定義します。この仕様書はAPIの設計図として機能するとともに、ツールによって自動処理が可能です。
OpenAPIが重要視される理由は、エコシステムの充実にあります。
- Swagger UIなどでインタラクティブなAPIドキュメントを自動生成
- 各言語向けのクライアントSDK・サーバースタブの自動生成
- APIのバリデーションやテスト自動化
- チームやサービス間でのAPI設計合意の基準
マイクロサービスやSaaS連携が当たり前になった現代において、OpenAPIはAPIファーストの開発文化を支える基盤技術として、バックエンドエンジニアにとって必須の知識となっています。
使い方・例文
バックエンドチームがOpenAPI仕様書を作成しておくと、フロントエンドチームはその定義からTypeScriptの型やAPIクライアントを自動生成でき、手書きの型定義ミスを防げます。
この用語をシェア
最終更新: