ドラフト製品の編集

ドラフト製品を初期作成した後は、さらに製品の構成を続けることも、後で構成変更を行うこともできます。

このタスクについて

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

製品の初期作成時には、製品作成ウィザードで最小限の構成設定を入力するための手順が示された後、「製品の編集」ボタンが表示されます。ここからは、追加の構成をすぐに指定することも、製品に戻って後で編集することもできます。このトピックでは、どちらの場合にも該当する追加の構成の指定方法について説明します。

手順

ドラフト製品を編集するには、以下のステップを実行します。

以下のいずれかの方法で、「製品のセットアップ」ページにアクセスします。
- 製品の初期作成の完了後に「製品の編集」をクリックします。
- ナビゲーション・ペインで、「開発」をクリックし、「製品」タブを選択します。
- 編集する製品のタイトルをクリックします。
「製品のセットアップ」ページでは、以下の構成変更を行うことができます。
1. 「情報」セクションで、「タイトル」、「バージョン」、または「要約」を変更します。
2. 「連絡先」、「サービスのご利用条件」、および「ライセンス」の各セクションを使用して、必要に応じて対応する詳細を入力します。
3. ゲートウェイ・タイプを変更します。詳細については、および API Connect ゲートウェイの種類を参照してください製品のゲートウェイタイプを指定する。
4. 変更内容を保存するには、「保存」をクリックします。
（任意） ：コンシューマーカタログで商品と共に表示する商品メタデータを指定します：
1. 「ソース」タブをクリックして、製品の OpenAPI ソースを表示します。
2. カスタム属性 x-name: value を info セクションに追加します。以下に例を示します。
```
info:
  version: 1.0.0
  title: Multi Plans
  name: multi-plans
  x-customarg: This is the custom value
...
```
  ここで、 customarg はカスタム・メタデータの名前、 This is the custom value は情報コンテンツです。
3. 「保存」をクリックします。
  製品がコンシューマーカタログに公開されると、カスタムメタデータが製品とともに表示されます。例えば：
「可視性」をクリックし、必要に応じて以下の変更を行います。
1. 「可視性」セクションで、この製品が表示されるユーザーを指定します。「公開」を選択して、製品がすべてのユーザーに表示されるようにするか、「認証済み」を選択して、正常に認証されたユーザーが製品を使用できるようにするか、「カスタム」を選択して、製品を表示するコンシューマー組織およびコンシューマー組織グループを指定できます。
  「カスタム」を選択した場合は、以下の手順を実行します。
  - 可視性を制御するカタログを選択します。
  - 「組織およびグループの検索」フィールドを使用して、製品を表示する、選択したカタログ内のコンシューマー組織およびコンシューマー組織グループを検索します。必要に応じて、現在は存在しないが将来追加される予定の消費者団体や団体グループの名前を入力することができます。後で、同じ名前で作成してください。コンシューマー組織およびコンシューマー組織グループを作成および管理する方法については、コンシューマー組織の管理を参照してください。
2. 「サブスクライブ可能性」セクションで、製品内のプランをサブスクライブできるユーザーを指定します。「認証済み」を選択して、正常に認証されたユーザーが製品内のプランをサブスクライブ可能にするか、「カスタム」を選択して、製品内のプランをサブスクライブできるコンシューマー組織およびコンシューマー組織グループを指定することができます。
  「カスタム」を選択した場合は、以下の手順を実行します。
  - サブスクライブ可能性を制御するカタログを選択します。
  - 「組織およびグループの検索」フィールドを使用して、製品をサブスクライブ可能にする、選択したカタログ内のコンシューマー組織およびコンシューマー組織グループを検索します。必要に応じて、現在は存在しないが将来追加される予定の消費者団体や団体グループの名前を入力することができます。後で、同じ名前で作成してください。コンシューマー組織およびコンシューマー組織グループを作成および管理する方法については、コンシューマー組織の管理を参照してください。
  注:
  - カスタムの可視性またはサブスクライブ可能性を選択した場合、コンシューマー組織およびコンシューマー組織グループの選択リストには 10 件の検索結果のみが表示されます。必要に応じて、より具体的な検索ストリングを入力して検索を絞り込みます。
  - 各組織またはグループのタイトルが表示され、その後に括弧で囲まれた名前が表示されますが、選択された組織およびグループのテーブルには名前のみが表示されます。
1. 変更内容を保存するには、「保存」をクリックします。
注：製品の公開時に、表示設定や購読設定を変更することができます。「下書きの製品を公開する」を参照してください。製品の公開先のカタログで設定を変更することもできます。製品の可用性の変更を参照してください。
製品に組み込む API を指定するには、「API」をクリックしてから、以下の手順を実行します。
1. 「編集」をクリックします。
  すべてのドラフト API がリストされます。
2. 組み込む API を選択します。ステージングには、ゲートウェイの種類がプロダクトのゲートウェイの種類と一致するAPI、または「強制適用」オプションが無効になっているAPIのみを含めることができます。「Enforced 」オプションが無効になっているAPIは、ゲートウェイ API Connect 上で管理されません。ゲートウェイ・タイプがこの製品のゲートウェイ・タイプと一致しない互換性のない API を選択すると、警告メッセージが表示され、互換性のない API の選択がクリアされるまでは変更を保存できません。ゲートウェイの種類に関する詳細については、製品のゲートウェイタイプを指定する、、 API Connect ゲートウェイの種類を参照してください API定義におけるゲートウェイタイプの指定。
3. 完了したら、「保存」をクリックします。
  選択した API がリストされます。
注: アプリケーション開発者が API を使用できるようにするには、API をプランに組み込む必要があります。
任意： 製品に請求機能の連携を追加する。「プラン」をクリックし、「請求統合」セクションで、製品に適用する請求統合リソースを選択します。
「プラン」セクションで、デフォルト・プランを編集して価格設定情報を追加することも、価格設定情報を含む新規プランを作成することもできます。請求の統合について詳しくは、製品の収益化を参照してください。
任意： 製品に1つ以上のプランを追加するか、既存のプランを変更します。 1 時間当たりの API 呼び出し数 100 回のレート制限があるデフォルトのプランが自動的に作成されます。
1. 「計画」をクリックします。
2. 新規プランを追加するには、「追加」をクリックします。既存のプランを変更するには、対象のプランの横にあるオプションアイコンをクリックし、次に「編集」をクリックしてください。
3. 計画の「タイトル」を指定し、オプションで説明を指定します。「名前」は自動的に入力されます。
  
  注: 「名前」フィールドの値は、デベロッパーズ・ツールキット CLI コマンドでプランを識別するために使用される単一のストリングです。「タイトル」は表示に使用されます。
4. プランにサブスクリプションの承認が必要かどうかを指定します。開発者によるサブスクリプションに承認を必要とする場合は、「承認」チェック・ボックスを選択します。そうでない場合は、チェック・ボックスがクリアされていることを確認します。
  注:
  サブスクリプションのタスク履歴を表示するには、以下の手順を実行してください：
  
  API Manager UI のナビゲーションペインで、 [管理] をクリックし、操作したいカタログを選択します。
  
  [タスク] タブをクリックします。
  
  ナビゲーションペインから「承認履歴」をクリックします。
5. 「プランの価格設定」セクションで、以下のステップを実行して価格設定情報を追加できます。
  1. 「プランの価格設定」のトグルを「オン」に変更します。「プラン価格設定」定義セクションが表示されます。
  2. プランに無料トライアル日数を含める場合は、「無料トライアル日数を含める」を選択し、サブスクライバーがプランを無料で使用できるトライアル日数を入力します。この日数を過ぎると、請求サイクルが開始されます。
  3. 請求プロセスで使用する「通貨」を選択します。
  4. サブスクライバーに請求する「月額」を入力します。選択した通貨が小数単位をサポートしている場合は、小数単位 (セントなど) を含む価格を入力します。
  製品の請求統合について詳しくは、請求統合を使用した製品の定義を参照してください。
6. 「プランのレート制限」セクションで、レート制限を変更し、「追加」をクリックしてさらにレート制限を追加することができます。複数のレート制限を秒、分、時間、日、および週単位の時間間隔で設定できます。レート制限を解除するには、対応する削除アイコンをクリックしてください。
  
  注: API Connectでのレート制限およびバースト制限について詳しくは、 API およびプランのレート制限についてを参照してください。
7. 「プラン・バースト制限」セクションで、バースト制限を変更し、「追加」をクリックしてさらにバースト制限を追加することができます。バースト制限は、インフラストラクチャーを損なう可能性がある使用量スパイクを防ぐために使用します。複数のバースト制限を秒および分単位の時間間隔で設定できます。バースト制限を解除するには、対応する削除アイコンをクリックしてください。
  レート制限とバースト制限は連携して動作し、プランでカバーされる API のネットワーク・トラフィックを管理します。プランには複数のレート制限およびバースト制限を設定できますが、各時間間隔には、1 セットの制限のみを割り当てることが推奨されます。レート制限とバースト制限を調整して、ネットワークが過負荷にならずに最大トラフィックを許可できるようにします。 レート制限は、一定の時間間隔 (例えば、1 日) 内にネットワーク上の API にアクセスするための持続可能な進行中のトラフィックの最大量を設定します。 バースト制限は、一定の時間間隔 (秒または分あたり) 内のネットワークの短期間最大トラフィック量を設定します。
  
  バースト制限により、増加トラフィックの短時間のバーストが許可されます。 バースト制限を超過すると、次のバースト制限間隔が開始されるまで、後続のすべての API 呼び出しは拒否されます。次の間隔の開始時にバースト制限カウンターがゼロにリセットされるため、API 呼び出しを再度受け入れることができます。これらの API 呼び出しはレート制限カウンターにカウントされますが、バースト制限カウンターのリセットはレート制限カウンターには影響しません。
  
  レート制限とは、ある時間間隔で許可される API 呼び出しの数のことです。例えば、1 日あたり1000 個の呼び出しです。 レート制限を超過し、「ハード制限」が有効になっている場合、後続のすべての API 呼び出しは拒否されます。次のレート制限間隔の開始時にレート制限カウンターがゼロにリセットされるため、API 呼び出しを再度受け入れることができます。「ハード制限」が無効な場合、以降のすべての API 呼び出しは引き続き受け入れられ、レート制限を超過したことを示すメッセージがログに記録されます。これは「ソフト制限」と呼ばれます。
  
  「ハード制限」は、以下のシナリオに示すように、レート制限にのみ影響します。
  シナリオ A
  
  表 1. ハードリミットが有効になっています
  
  ハード制限バースト制限レート制限
  
  ON 100 個の呼び出し/分 1000 個の呼び出し/日
  
  ユーザーが 1 分間に API を 100 回呼び出すと、バースト制限に達します。同じ 1 分内の 101 番目の呼び出し (および後続のすべての呼び出し) は拒否されます。その分が満了すると、バースト制限カウンターはリセットされます。すべての API 呼び出しは、1 日あたり 1000 個の呼び出しのレート制限に対して集計されます。 バースト制限カウンターのリセットは、レート制限カウンターには影響しません。
  
  ユーザーが API を 1 分当たり 99 回呼び出す場合は、バースト制限には達しません。最終的に、それらの呼び出しは 1 日あたり 1000 個の呼び出しのレート制限に達し、1001 番目の呼び出しは、その同じ 1 日のレート制限間隔が終了するまで拒否されます。日次のレート制限が超過したために API 呼び出しが拒否される期間中は、バースト制限はアクティブ化されません (呼び出しが既に拒否されているため)。
  
  バースト制限とレート制限は両方ともコンシューマーごとに適用されます。
  
  シナリオ B
  
  表 2. ハードリミットの無効化
  
  ハード制限バースト制限レート制限
  
  オフ 100 個の呼び出し/分 1000 個の呼び出し/日
  
  シナリオ A と同様に、ユーザーが 1 分間に API を 100 回呼び出すと、同じ 1 分間での 101 回目の呼び出しは、その 1 分間が終わってカウンターがリセットされるまで拒否されます。これらの呼び出しは、1 日あたり 1000 個の呼び出しのレート制限 にもカウントされます。
  
  ユーザーが API を 1 分当たり 99 回呼び出す場合は、バースト制限には達しません。最終的に、それらの呼び出しは 1 日あたり 1000 個の呼び出しのレート制限に達し、101 番目の呼び出しは受け入れられます (ハード制限がないため)。時間間隔 (1 日) が満了してカウンターがリセットされるまで、後続の呼び出しごとにメッセージがログに記録されます。その日の残りの期間中、バースト制限は引き続き適用され、特定の 1 分内の呼び出し数が 1 分当たり 100 個を超えると、呼び出しは拒否されます。
  
  バースト制限とレート制限は両方ともコンシューマーごとに適用されます。
  注: 「ハード制限」にチェック・マークが付いていない場合、 レート制限 は「ソフト制限」と見なされます。ソフト制限では、レート制限に達した後に呼び出しは拒否されません。代わりに、メッセージがログ・ファイルに記録されます。ソフト制限では引き続き、バースト制限を超過するとAPI 呼び出しは拒否されます。
8. ステップ 5で製品に組み込まれたすべての API をプランに含めるには、「プラン API」セクションで「製品と同じ」を選択します。
9. GraphQL 「レート制限」セクションで、製品に追加されるすべての GraphQL プロキシー API に適用されるレート制限を構成できます。
  次のレート制限を使用できます。
  graphql-field-cost
  
  このプラン内の GraphQL プロキシー API に対して行われた GraphQL 照会呼び出しの、計算対象フィールドの合計コストに制限を適用します。
  
  graphql-design-request
  
  このプラン内の GraphQL プロキシー API に対して行われた、以下のすべてのタイプの呼び出しの総数に制限を適用します。
  
  GraphQL 照会のコストを取得するために graphql/cost エンドポイントに送信された要求。詳細については、「 GraphQL API のコストエンドポイントの有効化」を参照してください。
  
  /graphql エンドポイントに送信された標準イントロスペクション要求。詳細については、「 GraphQL API のイントロスペクションのサポート」を参照してください。
  
  /graphql エンドポイントに送信された、GraphiQL エディターに対する HTML Web ブラウザー要求。詳細については、「 GraphQL API での GraphiQL エディタの有効化」を参照してください。
  
  graphql-input-type-cost
  
  このプラン内の GraphQL プロキシー API に対して行われた GraphQL 照会呼び出しの、計算対象入力タイプの合計コストに制限を適用します。
  
  graphql-type-cost
  
  このプラン内の GraphQL プロキシー API に対して行われた GraphQL 照会呼び出しの、計算対象タイプの合計コストに制限を適用します。
  計算されたコストは、GraphQL スキーマ内のタイプおよびフィールドに適用される加重係数によって異なります。 GraphQL プロキシAPIの詳細、および型とフィールドの重みの設定については、「 GraphQL プロキシAPIの作成」および「 GraphQL スキーマエディタの使用」を参照してください。
10. 1 つ以上のアセンブリー・バースト制限またはアセンブリー・カウント制限を定義するには、「アセンブリー・バースト制限」セクションまたは「アセンブリー・カウント制限」セクションで「追加」をクリックします。バースト制限の場合は、特定の期間内に許される呼び出しの最大数を指定し、カウント制限の場合は、最大呼び出し制限を指定します。指定した名前は、API アセンブリ内のレート制限ポリシーで使用され、適用するバースト制限またはカウント制限をポリシーで定義できるようにします。詳細については、「レート制限」を参照してください。
11. プランに含める API を選択するには、「プラン API」セクションで「プラン API リストのカスタマイズ」を選択してから、「編集」をクリックします。「プラン API の編集」ウィンドウが開きます。選択可能な API は、ステップ 5で本製品に組み込まれたものです。チェック・ボックスを使用して、必要な API を指定します。完了したら、「保存」をクリックします。
12. プランに含める特定のAPI操作を選択するには、対象のAPIの横にあるオプションアイコンをクリックし、次に「操作リストを編集」をクリックします。「含める操作を選択します」ウィンドウが開きます。チェック・ボックスを使用して、必要な操作を指定します。完了したら、「保存」をクリックします。
13. プランからAPIを削除するには、「プランのAPI 」セクションで対象のAPIの横にあるオプションアイコンをクリックし、次に「削除」をクリックします。
14. プラン内の任意の GraphQL API について、このプランのサブスクライバーが特定のタイプまたはフィールドを使用できないようにするには、以下のステップを実行します。
  1. 「 Plan APIs 」セクションで、必要な GraphQL APIの横にあるオプションアイコンをクリックし、次に「設定の表示/非表示を編集」をクリックします。
  2. 特定の GraphQL タイプが使用されないようにするには、そのタイプの横にあるチェック・ボックスの選択を解除します。
  3. 特定のタイプの特定のフィールドが使用されないようにするには、対象のタイプを展開し、そのフィールドの横にあるチェック・ボックスの選択を解除します。
  4. 完了したら、「次へ」をクリックしてください。要約ウィンドウが開きます。操作が許可された場合、非表示になる関連エレメントもリストされます。例えば、あるタイプを非表示にし、そのタイプが別のタイプのフィールドのデータ・タイプとして参照されている場合、そのフィールドも非表示になります。操作が許可されない場合は、説明が表示されます。
  5. 操作が許可された場合は、「完了」をクリックして変更を適用します。操作が許可されない場合は、「キャンセル」をクリックしてウィンドウを閉じるか、「戻る」をクリックして設定を修正します。
  「表示/非表示の設定の編集」オプションを使用して、既存の設定を変更できます。追加のタイプやフィールドを非表示にしたり、以前に非表示にしたタイプやフィールドを表示したりすることができます。
15. 特定のAPI操作に対してレート制限を設定するには、「 Plan APIs 」セクションで「個々の操作に対してプランのレート制限を上書きする」を選択してください。詳細については、「API操作に対するレート制限の設定」を参照してください。
16. 変更内容を保存するには、「保存」をクリックします。
オプション： コンシューマーカタログでプランと共に表示するプランのメタデータを指定します：
1. 「ソース」タブをクリックして、プランの OpenAPI ソースを表示します。
2. カスタム属性 x-name: value を適切な plan セクションに追加します。以下に例を示します。
```
...
plans:
  default-plan:
    title: Default Plan
    description: Default Plan
    x-customarg: This is the custom value
    rate-limits:
      default:
        value: 100/1hour
        hard-limit: false
      minute:
        value: 20/1minute
        hard-limit: false
    apis:
      petstore-header-clientid1.0.0: {}
...
```
  ここで、 customarg はカスタム・メタデータの名前、 This is the custom value は情報コンテンツです。
3. 「保存」をクリックします。
  プランが「コンシューマー・カタログ」に掲載されると、そのプランとともにカスタムメタデータが表示されます。例えば：
任意： をクリックしカテゴリー、商品を分類したいカテゴリを定義してください。変更内容を保存するには、「保存」をクリックしてください。
商品をカテゴリ別に整理することで、コンシューマーカタログ上で商品を階層的に表示することができます。詳細については、 tapic_apionprem_categories.html をご覧ください。

表 1. ハードリミットが有効になっています
ハード制限	バースト制限	レート制限
ON	100 個の呼び出し/分	1000 個の呼び出し/日

表 2. ハードリミットの無効化
ハード制限	バースト制限	レート制限
オフ	100 個の呼び出し/分	1000 個の呼び出し/日

次のタスク

製品をカタログにステージングします。詳細については、「ドラフト製品のステージング」を参照してください。