Swagger概要
Swagger(読み方はスワッガー)とは、OpenAPI仕様(OAS)と呼ばれる、REST APIを定義するための仕様に基づいて製作されたツールです。
Swaggerで提供されている主なツールは以下のものがあります。
| ツール | 説明 |
|---|---|
| Swagger Spec | REST APIに対して Swagger の仕様に準じたドキュメント |
| Swagger Editor | Swagger Spec の設計書を記載するためのエディタ。HTMLでの表示やAPIクライアント、APIサーバのスタブコードの作成も行える。HTMLからAPI呼び出しもできる |
| Swagger UI | Swagger Spec で記載された設計からドキュメントをHTML形式で生成するツール |
| Swagger Codegen | Swagger Spec で記載された設計からAPIスタブを生成するツール |
ツールの全体像は以下の様になります。
Swagger Spec
Swagger Spec はSwaggerの書式で記述した仕様書です。JSONもしくはYAML形式で記載します。
Swagger Editor
Swagger Editerは Swagger ファイルの生成や編集を行うためのツールです。ブラウザ上で動きます。左側にYAMLまたはJSONで記述します。右側には左の記述をもとに生成されたドキュメントです。リアルタイムにドキュメントが更新されるので構文チェックを行うこともできます。またこの画面からAPIの実行も可能です。基本となるのはこのツールです。
Swagger UI
Swagger UIは Swagger-Specを読み込んで、HTMLで表示するツールです。
Swagger Codegen
Swagger Specで記載された設計からクライアント/サーバコードを生成するコマンドラインツールです。数多くの言語やフレームワークに対応しています。
コメント