API の開発について知見を増やそうと思い swagger について調べてみました。
Swagger とは
Swagger は RESTful APIを構築するためのオープンソースのフレームワークのことです。
RESTfulAPI を楽に設計、製造しようというプロジェクトのようで海外では結構使われているみたいです。
特徴
Swagger Specという仕様を元にドキュメントを記載しておけば、自動で見やすいドキュメントやコードの生成などが行えます。
Editor、UI、Codegen の３つのツールがメインになっているようです。
ツール
Swagger Editor
Swagger 用のエディタで、Web ブラウザーでの Swagger 文書の作成を支援します。
editor.swagger.io
Swagger UI
Swagger Spec で記載された設計からドキュメントを HTML 形式で自動生成するツールです。
swagger.io
Swagger Codegen
Swagger Codegen とは "OpenAPI Specificatioin" に従って記述されたAPI仕様書を元に、ソースコードを生成するツールです。
github.com
