API呼び出しの詳細の把握

Swagger Webページには、API呼び出しの詳細情報が表示されます。すべてのAPI呼び出しが文書化され、共通の形式で表示されます。1つのAPI呼び出しについて理解すれば、他のAPI呼び出しの詳細も同様に表示して解釈できるようになります。

手順

  1. Swaggerのメイン ページで、[sessions]をクリックします。
  2. [POST]をクリックして、認証トークンを要求するために使用するAPI呼び出しの詳細を表示します。


    API呼び出しの詳細の例

  3. ページ全体を調べて、API呼び出しおよび入力が必要な項目を確認します。
    HTTP動詞とURL、必要な入力パラメータ、HTTPステータス コード、および実装メモを確認しておきます。