【環境構築】swaggerの使い方とメリット

シェアする

読了: 約 1 分

最近自分がやっているコトのメモになってしまっていますが、
良いツールがあったので、今後使うときの学習コストを下げるためにメモ。

swaggerとは

APIドキュメントの生成するフレームワークのコト。
下記の記事が参考になりました。
swaggerについて調べてみた

ポイント

・jsonで表示される。
・UIが綺麗でわかりやすい。

クライアント側への作業の受け渡しという点でかなり便利かなと思いました。

本サイト

使い方

任意のディレクトリにインストールして、諸々設定します。
サーバーサイドの方に聞いた方が良いかもしれませんね。

認証が必要なアプリケーションでもid等入力して、try it out!というボタンをクリックすれば、
ログイン状態で、apiの値が返ってきます。

それを見ながらフロント側の人が作業すれば良いので、
作業を分担し易くて、可視化しやすいので便利かと思います。

シェアする

フォローする