カタログの処理

製品をアプリケーション開発者に対して使用可能にするには、製品をカタログにステージングしてから、開発者組織に公開する必要があります。IBM® API Connect では、複数のカタログを作成することができます。開発者組織に対して使用可能にする前にテストする目的で製品と API を分離する場合に、カタログが役立ちます。[V5.0.5 以降]IBM API Connect のシンジケーション機能により、製品は、カタログ内の スペース にも公開できます。

カタログはステージング・ターゲットであり、開発者ポータルおよびゲートウェイの論理パーティションとして動作します。API 呼び出しの URL と開発者ポータルは、特定のカタログに固有のものです。標準的な構成では、API プロバイダー組織は開発中の API のテストには開発カタログを使用し、完全利用の準備ができている API のホスティングには実稼働カタログを使用します。一般的には、1 つの開発カタログといくつかのテスト・カタログで構成される開発クラウドと、専用のテスト・カタログを備えている実動クラウドを使用します。

[V5.0.5 以降]1 つのカタログ内で複数のチームが製品および API を独立して管理できるように、スペース を使用してカタログを区分化できます。スペースは、概念的にはサブカタログのようなものですが、指定されたカタログ内のすべてのスペースの製品および API は同じ開発者ポータルに公開されるという特徴があります。スペースについて詳しくは、IBM API Connect でのシンジケーションの使用を参照してください。

カタログのタイプ

カタログには以下のタイプ設定を適用できます。
[V5.0.2 以前]サンドボックス
[V5.0.2 以前]

開発カタログの場合は「サンドボックス」設定を使用します。開発カタログでは、ステージングと公開のアクションが強制的に実行されるため、以前に公開した製品を再公開する場合に、警告なしで上書きされます。競合が見つかった場合は、システムによって自動的に解決されます。非公開にするアクションは自動的に実行されます。さらに、公開およびライフサイクル・アクションのために承認がバイパスされます。承認を必要とするようにカタログを構成することはできません。非開発カタログが開発カタログに変換されると、保留中の承認は取り消されます。

デフォルトでは、開発カタログが提供されます。開発カタログはテスト以外の目的に使用しないでください。開発カタログでテスト・ツールを使用するときには、テストする製品がすべて強制され、操作が開発者ポータル上で使用されている場合でも、ステージング済みおよび公開済みの製品を上書きします。開発カタログから作成された開発者ポータルも同じく、実際のケースではなく、テスト目的のみで使用される必要があります。

[V5.0.3 以降]開発
[V5.0.3 以降]

[V5.0.4 以前]開発カタログでは、ステージングと公開のアクションが強制的に実行されるため、以前に公開した製品を再公開する場合に、警告なしで上書きされます。競合が見つかった場合は、システムによって自動的に解決されます。非公開にするアクションは自動的に実行されます。

注:
  • [V5.0.4 以前]開発カタログでは、公開およびライフサイクル・アクションのために承認がバイパスされます。承認を必要とするようにカタログを構成することはできません。非開発カタログが開発カタログに変換されると、保留中の承認は取り消されます。
  • [V5.0.5 以降]開発カタログは、ステージングおよび公開のアクションで承認が必要になる点に関しては、他のカタログと同じ動作になります (カタログが承認を要求するように構成されている場合)。

デフォルトでは、開発カタログが提供されます。開発カタログはテスト以外の目的に使用しないでください。開発カタログから作成された開発者ポータルも同じく、実際のケースではなく、テスト目的のみで使用される必要があります。

[V5.0.4 以前]開発カタログでテスト・ツールを使用するときには、テストする製品がすべて強制され、操作が開発者ポータル上で使用されている場合でも、ステージング済みおよび公開済みの製品を上書きします。

[V5.0.3 以降]自動サブスクリプション
[V5.0.3 以降]
カタログの自動サブスクリプションを有効にすると、API Manager ユーザー・インターフェースでの API のテストが容易になります。これは、カタログ内のすべてのプランを自動的にサブスクライブするテスト・アプリケーションが、事前に指定したクライアント ID とクライアント・シークレットを使用して行われるため、テスト時にプランやアプリケーションを指定する必要がなくなります。テスト・アプリケーションにはレート制限が適用されません。自動サブスクリプションは開発カタログに対してのみ使用できます。
[V5.0.3 以前]注: 自動サブスクライブは、DataPower® Gateway を使用した場合に限りサポートされます。
デフォルト
いずれかのカタログをデフォルトのカタログに設定できます。その場合、カタログに公開された API の呼び出しで、カタログ名を含まない短縮 URL を使用できます。

開発者ポータルの使用方法について詳しくは、『API の検出と使用』を参照してください。

「タイム・スタンプ」アイコン 最終更新: 2017 年 11 月 1 日