Swagger

昨日Heisei.rbへ参加した際、Swaggerというツールを知り、気になったので触ってみました!

一緒に毎日ブログ投稿するメンバーの影響で今日は動画入れてみましたっ!!w

 

 

Swaggerとは

 

REST APIの設計やドキュメント作成、動作確認ができるツールです。

REST APIのパスやパラメータ、レスポンスを記述したYMLファイルを記述し、Swaggerを使用することで、Web上でRestfulAPIの動作確認が可能です。

Swagger EditorSwagger UISwagger Codegenなど関連ツールがいくつかあります。

 

 

 

 

使い方

オンライン上のエディタを使ってみます。

仕様を書いていくymlファイルがあるので、自分のプロジェクトの情報を書いていきます。

 

editor.swagger.io

 

以下のような画面に飛ぶので左のエディタに自分のプロジェクトの情報を書いていきます。

gyazo.com

 

 

post でpetというパスにアクセスした時の情報を左のように書いてあげると、右のようなドキュメントを生成してくれます!!

gyazo.com

 

 

 リアルタイムで変更を反映してくれるので分かりやすい!!

Image from Gyazo

 

 

感想その他

Swagger触りながらAPIへの理解も深めていこうと思います!!