すべてのプロダクト
Search
ドキュメントセンター

2. フロントエンドの設定

最終更新日: Mar 20, 2020

手順 1:グループを作成します

Create a group

手順 2:ドメイン名をバインドします

Domain name instructions

  1. グループを作成したら、グループ詳細ページに進み、上図のとおりグループのサブドメインを取得します。
  2. 外部の独自ドメイン globalservice.api.com を購入するウェブサイトに移動し、ドメイン名の CNAME をグループのサブドメインに解決します。
  3. CNAME を解決したら、グループ詳細ページに戻り、ドメイン名のバインドをクリックしてグループに globalservice.api.com をバインドします。
  4. バックエンドが HTTPS を使用する場合、SSL 証明書が必要です。ファイルのアップロードに対応していないため、証明書のコンテンツはコピーおよび貼り付けなければなりません。

手順 3:API を作成します:基本情報

基本情報 では、API グループ、API 名および API 認証方法を設定し、API の詳細を完成させます。

Configure API basic information

  1. 上図のとおり、API リスト ページに移動します。

  2. API グループと同じリージョンを選択します。

  3. セキュリティ認証に注意します。

    • Alibaba Cloud APP:ユーザーが作成された API を呼び出す際、API Gateway は、アプリのキーおよび「秘密鍵」を検証します。そのため、クライアントの検証を自前で実装する必要があります。
    • 認証なし:呼び出し方法を手にした者は誰でも作成された API を呼び出すことができ、呼び出した者を特定できないため、呼び出し状況を集計することができません。

手順 4:API を作成します:API リクエストを定義します

API リクエストの定義 第三者ユーザー、つまり、フロントエンドが API を呼び出す際に使用し、リクエスト フォーマットを完成させます。

最初にプロトコル、Path およびメソッドを設定します。下図を参照。

Configure API service information

  1. プロトコルを設定します。

    • フロントエンドの設定は、同時に HTTP および HTTPS に対応します。バックエンドが HTTPS 対応の場合、SSL 証明書が独自ドメインに割り当てられなければなりません。
  2. リクエスト パスを設定します。

    • パスは、API を呼び出すときの URL.com 以降、 ? より前の部分を示します。パスに動的パラメーターを含むときの詳細は、次のセクションのバックエンドの設定手順をご参照ください。

      例:

      1. 呼び出す URL の最初の部分が次の場合:
      2. https://globalservice.api.com/getapilist?command=...
      3. パスは次のとおりです:
      4. /getapilist
  3. Body を含む API の場合、メソッドPost に設定します。

手順 5:API gateway:入力パラメーターを設定します

入力パラメーターの定義は、API を呼び出したときに渡されなければならないパラメーターを示します。

API gateway の入力パラメーター設定は、異なるパラメーターの順序に対応します。HeaderQueryBodyPath といったパラメーターをすべていっぺんに設定し、また、パラメーターの位置を設定します。最初の例に設定では、入力パラメーターの設定は次のとおりです:

Create API input parameter definitions

  1. パラメーター名の一意性は確認済みであることにご注意ください。
  2. 再度になりますが、このステップで API 呼び出す際の入力パラメーター、つまりフロントエンドにどのように表示させるかを設定することにご注意ください。このステップで 5 つのパラメーターを設定するには、URL? 以降を key value 形式でコマンドリージョンに変換し、Query部分を設定しなければなりません。また、キー 1キー 2 およびグループパラメーターはBody Formに変換され、Bodyに設定されなければなりません。
  3. 表示の定義に関連し、左のショートカットキーを使って迅速にパラメーターの順序を変えることができます。

フロントエンド入力パラメーターの設定はここで終わりです。次にバックエンド サービスの定義を設定します。