2.3. ベーシックパスの手順
ベーシックパスの手順は、個別にエンドツーエンドで実施できます。あるいは、必要に応じてこのパスの手順の一部を抜き出して実施することもできます。プロトタイプ、ベーシック、および アドバンスト パスは、それぞれ別々に実施することもできますが、互いに関連するものです。
2.3.1. API の保護
実稼働環境向けの完全な実装のためには、プロダクトの設定および 3scale とのインテグレーション方法に関して、基本方針を決定する必要があります。
プロダクトトラフィックの認証モードには、いくつかの選択肢があります。利用可能なオプションに関するガイド を確認し、設定を行ってください。
認証の設定を行ったら、認証モードを切り替えないでください。この操作により、既存のクレデンシャルが無効になる可能性があるためです。
関連情報
Hosted APIcast
- 管理ポータルへの初回ログイン後に、導入ウィザードの手順に従います。
- 実稼働環境に適したバージョンが得られるまで、アクセスポリシーの調整などのプロダクト設定を繰り返します。
- APIcast 設定を実稼働環境用ゲートウェイにプロモートします。
Self-managed APIcast
- この operator を使用して Self-managed APIcast ゲートウェイソリューションを OpenShift にデプロイします。
- 実稼働環境に適したバージョンが得られるまで、アクセスポリシーの調整などの API 設定を繰り返します。
- APIcast 設定を実稼働環境用ゲートウェイにプロモートします。
- Self-managed APIcast の詳細な情報は、APIcast のインストール を参照してください。
2.3.2. アプリケーションプランによる API アクセスポリシーの設定
API の保護 の手順を実施すると、認証された呼び出しだけがご自分のプロダクトにアクセスできるようになります。このセクションでは、ポリシーを適用して流量制御を変更します。
Red Hat 3scale API Management では、アプリケーション が API 製品にアクセスするための認証情報を定義します。アプリケーションには必ず 1 つ アプリケーションプラン が関連付けられ、アクセスポリシーが定義されます。アプリケーションは、開発者アカウント 内に保管されます。3scale の Basic プランでは、1 つのアプリケーションしか許可されません。より高度なプランでは、アカウントごとに複数のアプリケーションが許可されます。
プロトタイプ では、プロダクトの総ヒット数に基づいてアクセスを制御することしかできません。カスタムメソッドおよびメトリクスを使用して初めて、3scale の柔軟性を体感できます。カスタムメソッドおよびメトリクスを使用することで、アプリケーションプランおよびプロダクトの解析をより高度化できます。詳細は、解析に関するガイド を参照してください。
- API の構造と 3scale のメソッドまたはメトリックとの間のマッピングは論理的です。整合性のとれたルールを定義すれば、3scale からプロダクトの使用状況に関するレポートを受け取ることができます。詳細さのレベルを決める必要があります。一般的には、5 - 20 メソッド/メトリクスを目標とすることを推奨します。
- 3scale に報告される値は、増加するだけです。絶対値を設定したりカウンターを減らしたりすることはできません。
- 新たなメソッドまたはメトリクスを 3scale に追加したら、インテグレーションポイントに新しいシステム名を追加することが重要です。
- 実行時に、再デプロイせずに流量制御などに変更を加えることができます。
新しい製品を作成し、定義済みの
Echo APIを使用しない場合にのみ、新しいアプリケーションプランとアプリケーションを作成します。
前提条件
製品用の 3scale アプリケーションプランを作成 している。
- 次の例の手順では、アプリケーションプランの名前は Basic アプリケーションプランです。
- API 呼び出しをテストするための、デフォルトアカウント用のアプリケーションを作成 している。
次の手順の例では、アプリケーションプランの名前は Basic です。アプリケーションプランを作成したときに指定した名前を使用します。
手順
- [Your_product_name] > Applications > Application Plans の順に移動します。
- Application plans セクションで Basic アプリケーションプランに進み、3scale のインストールまたはサインアップ後にサンプルデータから生成されたプランのいずれかを編集します。
- Metrics, Methods, Limits & Pricing Rules セクションで、Hits 行の Limits を選択し、1 時間あたり 3 回の新しい使用限度を作成します。
- [Your_product_name] > Applications > Listing の順に移動し、サンプルアプリケーションを 1 つ選択します。アプリケーションが Basic プランに設定されていることを確認します。設定されていなければ、アプリケーションの詳細ページで プランを変更します。
- このアプリケーションのクレデンシャルを使用して、上記のサンプルコールを少なくとも 3 回繰り返します。
これで、3scale Basic プランのすべてのアプリケーションに対して、より制限の厳しいアクセスポリシーが正しく定義されました。
APIcast のデプロイメント
- [Your_product_name] > Integration > Configuration の順に移動します。
MAPPING RULES セクションをデプロイメントし、以下のマッピングを追加します。
注記"/" のデフォルトのマッピングは削除されています。このデフォルトマッピングを使用すると、ヒット数が二重にカウントされます。
2.3.3. 開発者ポータルを通じた開発者の参加
開発者ポータルの 作成 および開発者ポータルを使用した API の提供 については、関連のドキュメントを参照してください。コンテンツを Textile または Markdown で記述することを検討してください。オプションとして考慮すべき項目を以下に示します。
- ドキュメントにインタラクティブ機能を追加して開発者のドキュメント作業を容易にするために、ActiveDocs を設定する。
- ファビコンを追加する。
- CMS で partial セクションの analytics を編集して、Google Analytics トラッカーコードを追加する。
- サインアップのワークフローを設定する。
- メールテンプレートのコンテンツ をカスタマイズします。
