🌮
swagger editer導入
swagger editerを導入する
導入
公式Github
READMEに乗っ取り、Dockerでswagger editerを動かす
$docker run -d -p 80:80 docker/getting-started
ブラウザでlocalhostにアクセスするとこんな感じ。
使ってみる
左側エディターにはソースコードが表示されている。ここに、swaggerでapi仕様を書く。
すると、右側にapiのドキュメントのようなものが表示される。
ソースを修正すると、ドキュメントに即時反映される。再読み込み不要。
ドキュメントには、api仕様がまとめられている。
ドキュメントを見てみると、「Try it out」がある。
これをクリックすると、実際にapiを叩いてみることが可能。
- http・httpsと、スキーマの設定や
- GET・POSTなどメソッドとパラメータの設定
などが可能で、以下の様にリクエスト・レスポンス内容が分かりやすく？表示される。
Fileタブから、形式を指定して作成したswaggerファイルをダウンロードできる。
使い方としては、
swagger editerで、swaggerを書いて、ドキュメントからぽちぽちテストして、
問題なかったらyamlなりで出力して、使う。という感じかな。
いいですね〜。
Discussion