# APIエクスプローラ - Swagger

## 概要

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

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

1. [https://editor.swagger.io/ ](https://editor.swagger.io/)にアクセスします。
2. 調べたいプロビジョン・エンドポイントのYAMLファイルにアクセスしてダウンロードします。\
   [ファミリープラン](https://docs.keeper.io/jp/enterprise-guide-jp/personal-vaults-for-enterprise-and-business-users/apidekepuranwo)\
   [学生プラン](https://docs.keeper.io/jp/enterprise-guide-jp/personal-vaults-for-enterprise-and-business-users/apidenopuranno)
3. Swaggerで、File > Import をクリックし、ステップ2でダウンロードしたYAMLファイルを選択します。
4. YAMLファイルをインポートすると、swaggerのウェブサイトでは、左側の画面にYAMLファイルで定義されたAPI構成が表示され、右側に対応するAPIエクスプローラが表示されます。

<figure><img src="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2FYZ25LaqrvZtzPtLMgT8D%2Fswagger1.png?alt=media&#x26;token=8666d1ac-70ad-45fe-9e9d-76cbac833fed" alt=""><figcaption><p>この例では、ファミリープランのYAMLファイルを使用します。</p></figcaption></figure>

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

<figure><img src="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2FMio4Duz8MOZdlBSXiVRN%2Fswagger2.png?alt=media&#x26;token=54dc2272-19d2-49b0-a554-d6dd49cd13b4" alt=""><figcaption></figcaption></figure>

6. APIエンドポイントをテストするには、**"Try it out"**&#x30DC;タンをクリックしてください。

<figure><img src="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2FgWxFl4hZM9VXFNY71Bdl%2Fswagger3.png?alt=media&#x26;token=3252253e-a848-4a96-8efb-1f578a15a088" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2Fv8Lk9WdYG0UFG5YiM81Z%2Fswagger4.png?alt=media&#x26;token=115ee658-5461-4d3c-9033-24a8c30ba47c" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
APIパラメータとその定義方法の詳細については、[こちらのページ](https://docs.keeper.io/jp/enterprise-guide-jp/personal-vaults-for-enterprise-and-business-users/apitoraburushtingu/apiparamta)をご参照ください。
{% endhint %}

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