OpenAPIは、WebサービスのAPI仕様を記述するための言語非依存のオープンな規格です。以前はSwaggerと呼ばれていましたが、2016年に正式名称がOpenAPIに変更されました。
OpenAPIの主な特徴は以下の3つです。
- 言語非依存: JSONまたはYAML形式で記述するため、プログラミング言語に依存せずにAPI仕様を記述できます。
- 機械可読: コンピュータが理解できる形式で記述するため、APIの自動生成やテストなどに利用できます。
- オープンソース: オープンソースプロジェクトとして開発されており、誰でも自由に利用できます。
OpenAPIを利用することで、以下のメリットを得られます。
- API開発の効率化: API仕様を標準化することで、開発者がAPIを理解しやすくなり、開発効率が向上します。
- APIのドキュメント自動生成: OpenAPI仕様から、APIのドキュメントを自動的に生成することができます。
- APIのテスト: OpenAPI仕様を利用して、APIのテストを自動的に実行することができます。
OpenAPIは、REST APIの仕様記述と公開の標準フォーマットとして広く利用されています。多くのWeb APIがOpenAPI形式で公開されており、APIの利用者にとっても利便性の高い規格です。
OpenAPIの詳細については、公式サイト https://swagger.io/specification/ を参照してください。
参考資料
- https://swagger.io/specification/
- https://swagger.io/
- https://learning.postman.com/open-technologies/specifications/openapi/openapi/
- https://medium.com/@tiokachiu/must-read-openapi-generator-tutorial-practical-74eac84c0175
- https://lornajane.net/resource/intro-to-openapi
- https://qiita.com/shino365/items/80a50d6f1a6241ce52fa
- https://swagger.io/blog/api-strategy/difference-between-swagger-and-openapi/