結論:Swagger UIを使う
公式ドキュメント(Swagger UI)→ https://swagger.io/tools/swagger-ui/
Swagger UIは、OpenAPI仕様からインタラクティブなAPIドキュメントを自動的に生成するツールのこと
• ドキュメントから直接APIにリクエストを送信し、レスポンスを確認することができるインタラクティブなUI。• カスタマイズが可能で、APIのドキュメントを美しく表示。
• 組み込みの認証メカニズムにより、安全なテストが可能。
★Swagger EditorとSwagger UIをDockerで立ち上げてローカル環境でテストする方法もある
詳しくはコチラ💁
Swagger UIとSwagger EditorをWebサーバで動かす
(Dockerの知識不足なので割愛するけど、実際のAPIテストで試してみる予定)
★Swagger Editorの右側がSwagger UIにあたるのでGUIでテストしてみる
名称は次のとおりです。
APIのエンドポイント
:APIのエンドポイントと概要を表示
Try it out
:クリックすることでテストを行うことができる。クリック後にテスト用の入力エリアやボタンが表示される
Parameters
:リクエストのパラメータ情報を表示。Try it outをクリックすると入力または選択可能
Request body
:レスポンス情報の例を表示
4、テスト結果の表示
名称は次のとおりです。
Executeボタン
:APIのテストを実行
Clearボタン
:APIの実行結果をクリア
コマンドエリア
:APIテスト時のCurlコマンド及びリクエストURLが表示
Response body
:レスポンス結果を表示
参考記事:
Swaggerの機能について詳しく説明
Swaggar UIの使い方
開発効率を上げる!Swaggerの記法まとめ
Swagger UIとSwagger EditorをWebサーバで動かす