API インサイト で API を管理するための設定の構成
API 作成ツール、関係モデル、所有グループ、自動ワークフローなどの API インサイト設定を構成して、API ガバナンスと運用プロセスを簡素化します。
始める前に
必要なロール:sn_api_insights_ws.api_mgmt_architect_admin または sn_cmdb_admin
手順
- 移動先 ワークスペース > API インサイト.
- [設定] タブを選択します。
-
[すべての設定] オプションをオンにします。
注:このステップは、sn_cmdb_admin ロールを持つユーザーに適用されます。sn_api_insights_ws.api_mgmt_architect_admin ロールを持っている場合は、この手順をスキップできます。
-
[API 作成ツール (API creation tool)] セクションで、使用可能なオプションから API 作成ツールを選択します。
オプション 説明 なし 外部ツールを使用しません。 デジタル統合管理 有効になっている場合は、デジタル統合管理アプリケーション ( エンタープライズアーキテクチャワークスペースの一部) を使用して、デジタルインターフェイスレコードを作成して API 設計プロセスを開始します。 外部ツール API 作成にサードパーティツールを使用します。外部ツールの URL ( http://www.postman.comなど) を [外部 API オーサリングツール URL (External API authoring tool URL)] フィールドに入力する必要があります。 -
[API とビジネスアプリケーションの関係モデル (API-to-business application relationship model)] セクションで、使用可能なオプションから関係モデルを選択します。
オプション 説明 CSDM API を共通サービスデータモデル (CSDM) を使用して、まずアプリケーションサービスにリンクし、次にビジネスコンテキスト (ビジネスアプリケーションとも呼ばれます) にリンクします。 Digital Integration Management (デジタル統合管理) API をまずデジタルインターフェイスにリンクし、次にビジネスコンテキストにリンクします。 -
[所有グループ (Ownership group)] セクションで、API の管理を担当する所有グループを設定します。
オプション 説明 管理担当者グループ 全体的な管理とガバナンスを担当する特定のグループに API をアサインし、API の機能、セキュリティ、および事業達成目標との整合性を確保します。 注:デフォルトでは、SyncOwnershipGroupsOfAPIVersions スケジュール済みジョブがアクティブになっており、管理担当者グループが次の API バージョンに確実に同期されます。
変更グループ 変更を監督するグループに API をアサインし、ライフサイクルを管理して、サービスを中断することなく変更が文書化および実装されるようにします。 承認グループ 変更や展開などのアクションの承認を処理するグループに API をアサインし、必要な承認が確実に確保されるようにします。 サポートグループ インシデントの解決、安定性の維持、および問題のトラブルシューティングを担当するサポートグループに API をアサインします。 -
[ワークフローの構成 (Configure workflows)] セクションで、API アクションを自動化するためのワークフローを選択します。
注:ワークフローは、アドミニストレーターがワークフロースタジオを使用して作成します。「API インサイトでの API アクションのフローの構成」を参照してください。
- [保存] を選択します。