OpenAPI
OpenAPIとは、RESTful APIを記述するためのフォーマット。Swagger 2.0を拡張して実装されている。
Swagger
Swaggerとは、OpenAPIを用いてREST APIを設計する際に使用するツールセットのこと。
APIファースト開発をサポートするツール
YAML and JSONが扱える
API Documentation & Design Tools for Teams – Swagger
主なSwagger ツール
・Swagger Editor : OASに則ったAPI仕様を書くためのエディタ
・Swagger UI : OASに則ったAPI仕様からドキュメントを生成するツール
・Swagger Codegen : OASに則ったAPI仕様からコードを生成するツール
・SwaggerHub : SwaggerHubはSwagger Editor/UI/Codegenの機能がオールインワンになっています。GitHubアカウントと連携することが出来る。SwaggerHubアカウントを個別に作成しなくてもGitHubアカウントでログインして使用することが出来る。
また今度の機会に次のサイトを見て実施する。
Spring Bootとの連携方法が記載されている。ソースコードからAPI設計書が自動で生成できそうだ。