APIエクスプローラ - Swagger

概要

このドキュメントでは、FamilyとStudent Plans APIを理解し、独自のサンプルをテストするのに役立つSwaggerの使い方について詳しく説明します。

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

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

  2. 調べたいプロビジョン・エンドポイントのYAMLファイルにアクセスしてダウンロードします。 ファミリープラン 学生プラン

  3. Swaggerで、File > Import をクリックし、ステップ2でダウンロードしたYAMLファイルを選択します。

  4. YAMLファイルをインポートすると、swaggerのウェブサイトでは、左側の画面にYAMLファイルで定義されたAPI構成が表示され、右側に対応するAPIエクスプローラが表示されます。

この例では、ファミリープランのYAMLファイルを使用します。
  1. 右側のAPIコールを展開すると、APIエンドポイントのパラメータとレスポンスに関する詳細情報が表示されます。

  1. APIエンドポイントをテストするには、"Try it out"ボタンをクリックしてください。

  1. APIパラメータの値を入力後、"Execute"をクリックするとAPIコールが実行されます。

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

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

Last updated