素敵なサムシングを独断と偏見で一方的に紹介するブログ(´・ω・`)

IT

【炎上回避】APIドキュメントはSwaggerで定義すると幸せになれる説

投稿日:

スポンサーリンク

336×280




Swagger

What’s??

皆さんはSwaggerをご存知でしょうか?

Swaggerとは、RESTful APIAPIドキュメントを生成するためのオープンソースのフレームワークのことです。

Open API Initiative」という団体がRESTful APIのインターフェイスの記述をするための標準フォーマットを推進しており、その団体が考え出した規格のひとつがSwaggerです。

エクセルなどとは違い、テキストベースのファイルなのでGit管理がしやすいのもメリットの一つです。

Swaggerには、幾つかのモジュールがあります。

Swagger Spec

Swagger SpecはSwaggerの書式で記述した仕様書の事で、JSONもしくはYAML形式で記述します。

Swagger Editer

Swagger Editer>はSwaggerSpecファイルの生成や編集を行うためのツールです。
ブラウザ上で動作可能で、左側にYAMLまたはJSONで記述します。
そして、右側には左の記述をもとに生成されたドキュメントがリアルタイムに更新されるので、構文チェックを行いながら定義を行うことが出来ます。

Swagger UI

Swagger UIはSwaggerSpecを元に、HTML形式のドキュメントを生成するためのツールです。
SwaggerEditorから各言語で自動生成することが可能です。


SwaggerCodegen

Swagger Codegenとは、SwaggerSpecから, クライアントライブラリやスタブサーバー、ドキュメントを生成するツールです。
CLIから生成をすることが出来ますが、先ほど紹介したSwagger Editorからも生成することが可能です。

終わりに

以上のように、SwaggerはAPIドキュメントに関して定義から閲覧までを完全にサポートしており、API開発においてとても便利です。

まだ、エクセルパワポなどで管理している場合は、効率が格段に変わりますので是非導入してみてはいかがでしょうか?

336×280




336×280




CATEGORIES & TAGS

IT, , , , , , , , , ,

blogenist

Author: blogenist