手順

1. ウィザードを実行します。3scale ウィザードは、2 通りの方法で実行できます。

   • 3scale アカウントへの初回ログイン時に実行する。

   • 以下の URL アドレスの [Your_admin_domain] を置き換えてウィザードを実行する。

     \https://[Your-admin-domain]-admin.3scale.net/p/admin/onboarding/wizard/intro

     たとえば、管理ドメインが testing-area であれば、ウィザードは以下の URL から利用できます。

     https://testing-area-admin.3scale.net/p/admin/onboarding/wizard/intro

2. OK, how does 3scale work? をクリックします。
3. 紹介のアニメーションが表示されます。終了したら、Got it!Let's add my API をクリックします。

4. バックエンドを作成します。

   1. バックエンドの名前を指定します。たとえば、Inventory と指定します。
   2. バックエンドのベース URL を指定します。例: https://echo-api.3scale.net:443
   3. Add this Backend をクリックします。

5. プロダクトを作成します。

   1. プロダクト名を指定します。たとえば、Petstore と指定します。
   2. Add this Product をクリックします。

6. バックエンドをプロダクトに接続するためのパスを指定し、Add the Backend to the Product をクリックします。

   • デフォルト値のままで構いません。デフォルトのパスは / です。

7. GET リクエストによりテストを行うには、Send request をクリックします。

   • GET メソッドを指定できます。
8. 上記のステップを完了すると、API Gateway へのリクエストが成功したことを示す確認メッセージが表示されます。これ以降の設定の詳細を確認するには、Cool, what's next? をクリックします。

手順

1. Dashboard に移動します。
2. APIs セクションで、Backends カードの Create Backend をクリックします。

3. 以下の情報を指定します。

   • Name: バックエンドの識別子
   • System name: 内部での処理に使用される識別子。
   • Description: バックエンドに関するより詳しい情報を記述するオプションフィールド
   • Private Base URL: プライベート API のベース URL エンドポイント。
4. Create Backend をクリックします。

手順

1. Dashboard に移動します。APIs セクションで、Products カードの Create Product をクリックします。

2. 以下の情報を指定します。

   1. Name: プロダクトの識別子。

   2. System name: 内部での処理に使用される識別子。プロダクトの system_name を使用して、プロキシーエンドポイントおよびドメイン名が生成されます。デフォルトでは、system_name はラベルの一部で、ラベルのパターンは以下のどちらかになります。

      • ステージング環境用 APIcast の場合: %{system_name}-%{tenant_name}-apicast-staging
      • 実稼働環境用 APIcast の場合: %{system_name}-%{tenant_name}-apicast-production

      • 自動生成される URL ラベルが 63 文字を超えると、システムはラベルを <truncated-label>-<unique-hash> のように短縮します。

        • <truncated-label> は、元の URL の最初の 54 文字または 55 文字です。

        • <unique-hash> は、元のラベルから計算された一意の SHA-1 ハッシュの最初の 7 文字です。

          たとえば、省略される前の URL が以下であった場合、

          https://my-very-long-system-name-also-very-long-tenant-name-apicast-staging.3scale.net

          省略後の URL は以下のようになります。

          https://my-very-long-system-name-also-very-long-tenant-name-api-72588d2.3scale.net

   3. Description: プロダクトに関するより詳しい情報を記述するオプションフィールド
3. Create Product をクリックします。

手順

1. [Your_product_name] > Integration > Backends の順に移動します。
2. Add Backend をクリックします。

3. ドロップダウンリストから、以下のアクションの 1 つを実行します。

   • 既存のバックエンドを選択します。

   • View all をクリックして、リスト全体を表示します。

     • 新規バックエンドを作成する必要がある場合は、Create new Backend をクリックして詳細を入力します。
4. Path テキストボックスでルーティングパスを指定します。詳細は、特定プロダクトのバックエンドパス を参照してください。
5. Add to Product をクリックします。
6. [Your_product_name] > Integration > Configuration の Products タブでプロダクトをプロモートします。

1. アプリケーションがリクエストを送信する。
2. リクエストが公開 URL <public-api-domain>/supplies/list に送信される。
3. プライベート URL <private-api-domain>/list にリダイレクトする前に、バックエンドパスが削除される。
4. リクエストが Inventory バックエンドにリダイレクトされる。

手順

1. Dashboard で、マッピングルールを定義する Backend をクリックします。
2. ナビゲーションパネルで Mapping Rules をクリックします。
3. Create mapping rule をクリックします。

4. 以下の設定を指定します。

   • Verb: HTTP リクエストの動詞 (GET、POST、DELETE、または PUT)。
   • Pattern: 照合するパターン。たとえば、/hello 等。
   • Metric or method to increment: メトリクスまたはメソッドの名前。
   • Increment by: メトリックのカウントを増やす数。たとえば、1 と設定します。
   • Last?: リクエストが Last? とマークされたルールに一致する場合、APIcast は処理を停止し、残りのマッピングルールでの一致を検索しません。その後、メトリックのインクリメントも停止します。
   • Position: マッピングルール実行の順番を表す数字。マッピングルールの並べ替えに使用します。
5. Create mapping rule をクリックします。

手順

1. [Your_product_name] > Applications > Application Plans の順に移動します。
2. Create Application Plan をクリックします。
3. Create Application Plan のページで、新しいプランの名前およびシステム名を入力します。システム名は 3scale インストール環境内で一意である必要があります。
4. Create Application Plan をクリックします。

手順

1. Audience > Accounts > Listing の順に移動します。
2. デフォルトの Developer アカウントをクリックします。
3. Application タブをクリックします。
4. Create application をクリックします。
5. Create application ダイアログで、アプリケーションのプロダクトを選択します。
6. アプリケーションプランを選択します。
7. アプリケーション名を指定します。
8. Description フィールドに、このアプリケーションに関する情報を入力します。
9. Create application をクリックします。

手順

1. 新しい APIcast 設定をステージング環境にプロモートします。

   1. [Your_product_name] > Integration > Configuration の順に移動します。

   2. APIcast Configuration セクションで、Promote v.[n] to Staging APIcast をクリックします。

      • v.[n] は、プロモート先のバージョン番号を表します。
      • プロモートする変更がなければ、Nothing to promote のテキストと共にボタンがグレーアウト表示されます。

2. Staging APIcast セクションで、Promote v.[n] to Production APIcast をクリックして APIcast 設定を実稼働環境にプロモートします。

   • v.[n] は、プロモート先のバージョン番号を表します。
   • プロモートする変更がなければ、Nothing to promote のテキストとともにボタンがグレーアウト表示されます。

3. API プロダクトへのリクエストをテストするには、Example curl for testing に記載のコマンドをコピーして、ターミナルで実行します。

   • curl コマンドの例は、プロダクトの最初のマッピングルールに基づいています。
   • コマンドを実行すると、テスト中のバックエンドからの結果が含まれる HTML レスポンスが返されるはずです。
   • レスポンスが返されない場合は、プロダクトからキャッチオールマッピングルールを削除し、新しい APIcast 設定をステージング、続いて実稼働環境にプロモートし、curl のサンプルコマンドを実行します。

1. Audience > Developer Portal > Domains & Access の順に移動し、Developer Portal Site フィールドにカスタムドメインを入力します。
2. 必要に応じて、送信 Email フィールド にカスタムの送信メールアドレスを入力します。
3. 開発者ポータルのアクセスコードを削除します。
4. Update Account をクリックして変更を保存します。