APIエクスプローラ - Swagger

概要

本ページでは、Swaggerを用いてFamily Plans APIおよびStudent Plans APIを理解し、独自のサンプルをテストする方法を取り扱います。

SwaggerによるAPIエクスプローラ

1. https://editor.swagger.io/にアクセスします。

2. 利用するプロビジョン・エンドポイントのYAMLファイルをダウンロードします。 ファミリープラン 学生プラン

3. Swagger Editorで [File] > [Import] をクリックし、手順2でダウンロードしたYAMLファイルを選択します。

4. YAMLファイルをインポートすると、左側の画面にAPI構成、右側にAPIエクスプローラが表示されます。

この例では、ファミリープランのYAMLファイルを使用します。

1. 右側のAPIコールを展開すると、APIエンドポイントのパラメータとレスポンスに関する詳細情報が表示されます。

1. APIエンドポイントをテストするには、[Try it out] ボタンをクリックします。

1. APIパラメータの値を入力したうえで [Execute] をクリックすると、APIコールが実行されます。

APIパラメータとその定義方法の詳細については、こちらのページをご参照ください。

1. 実行後、レスポンスセクションにスクロールして結果を見ることができます。