1.3. API の初期設定
本セクションでは、API トラフィックを API キーで保護し、追跡し、3scale に設定した基本的な流量制御および管理機能で監視するための初期設定について、概要を説明します。3scale の操作が初めてであれば、ウィザードを実行して 最初の API を容易に設定することができます。
1.3.1. 新規プロダクトの作成
プロダクトは顧客がアクセスする API で、1 つまたは複数のバックエンドが含まれています。本セクションでは、プロダクトを 3scale に追加する方法について説明します。
以下のオプションのどちらかに従って、新規プロダクトを作成することができます。
- 手動でプロダクトを定義する。
- OpenShift からプロダクトをインポートする。
本セクションでは、手動での定義について詳細に説明します。OpenShift からプロダクトをインポートする場合には、管理ポータルガイドの サービスディスカバリー を参照してください。
前提条件
- 3scale アカウントが必要である。
手順
- Dashboard に移動します。
- APIS セクションで Products タブを選択します。
- New Product をクリックします。
以下の情報を指定します。
- Name: プロダクトの識別子
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
-
-
ステージング環境用 APIcast の場合:
- Description: プロダクトに関するより詳しい情報を記述するオプションフィールド
- Create Product をクリックします。
これらの手順を完了すると、一般に公開される API となるプロダクトが作成されます。次のステップは、バックエンドを作成し プロダクトに追加する ことです。
