Swaggar UIの使い方 #

Swagger は、 OpenAPI の仕様に沿って REST API を設計するためのオープンソースツール群です。

Node-AI Berry では API のドキュメント及び検証ツールとして Swagger UI を提供しています。 Swagger UI を用いることで、API の仕様を参照することに加えて、UI 上での簡易な API のテストを行うことができます。

Swagger に関する詳細仕様はリンク先をご確認ください。 ここでは基本的な利用方法について記載します。

Swagger UIの画面の見方 #

A. API のエンドポイント
API のエンドポイントと概要を表示しています。

B. Try it out
クリックすることでテストを行うことができます。
クリック後にテスト用の入力エリアやボタンが表示されます。

C. Parameters
リクエストのパラメータ情報を表示しています。
Try it out をクリックすると入力または選択可能となります。

D. Responses
レスポンス情報の例を表示しています。

APIテスト（Try it out）の方法 #

A. Execute ボタン
API のテストを実行します。
API にパラメータが必要な場合は事前に設定してください。

B. Clear ボタン
API の実行結果をクリアします。

C. コマンドエリア
API テスト時の Curl コマンド及びリクエスト URL が表示されます。

D. Response body
レスポンス結果を表示します。