OpenAPIは一度実務で使用したのですが、あまり分からず使用していたので調べて整理してみました。
概要
OpenAPIは正式には「Open API Specification」の略でREST API(RESTの原則に基づいて設計されたAPI)の記述フォーマットを指します。
RESTAPIはWebアプリケーションで情報をやり取りする際の規格で、OpenAPIは安全に通信するためにどのような形式にしたらいいかの仕様の定義になります。
Excelでもできますが、OpenAPIの方が管理など仕様が統一されてるので使いやすいです。
OpenAPIとSwagger
OpenAPIは元々Swaggerという名前でしたが、SwaggerがOpenAPI Initiativeに寄贈されたことでOpenAPIという名前になりました。
Swaggerの代表的なツールは以下になります。
- Swagger Editor・・・ブラウザでAPIの仕様書を書くためのエディター
- Swagger UI・・・APIの仕様書からドキュメントを作るためのツール
- Swagger Codegen・・・API仕様書からコードを作成するツール
他にもモックサーバーの作成やテストの実行もできます。
書き方
yamlかjsonで定義ファイルを記述します。
詳しくはこちら
OpenAPIがどんなものかは分かったと思います。