API 管理パターン
[Well-Architected Adaptable (適切に設計された適応可能)] → [Composable (構成可能)] → [Interoperability (相互運用性)] → [API Management (API 管理)] の詳細
| Where to look? 商品領域 | ロケーション |
What does good look like? (良いものは?) パターン |
|---|---|
| プラットフォーム | ビジネス | ✅ クライアントアプリケーションが最新の API バージョンを使用して Salesforce Platform API をコールする Salesforce クライアントアプリケーションが、使用している API バージョンを定期的に更新する |
| プラットフォーム | 設計標準 | ✅ コンポーネント間通信用の明確なプロトコル (API) が存在する |
| プラットフォーム | 設計標準 | ✅ プロトコル/API は、ビルダーが検索および見つけられる論理グループにまとめられています。 |
| プラットフォーム | 設計標準 | ✅ プロトコル/API では、変数のデータ型、変数名、必須または省略可能を定義し、使用する状況を明確に説明します。 |
| プラットフォーム | ドキュメント | ✅ 特定の API やプロトコルを検索し、実装しているコンポーネントを特定可能 |
| プラットフォーム | ドキュメント | ✅ すべてのコンポーネントのドキュメントに、実装済みの API/通信プロトコルが明記されている |
| プラットフォーム | 組織 | ✅ 内部コミュニケーション用の API メッセージ形式と変数をカスタムメタデータ型で定義 |
| プラットフォーム | 組織 | ✅ 内部コミュニケーション用の API メッセージ形式と変数はプラットフォームイベントで定義 |
| プラットフォーム | 組織 | ✅ コードおよび宣言型カスタマイズでは、情報を送受信するために適切なカスタムメタデータ型 (またはプラットフォームイベント) を参照します。 |
メッセージングおよびイベントパターン
適切に設計された適応性 → 構成可能 → 相互運用性 → メッセージングとイベントについての詳細
| Where to look? 商品領域 | ロケーション |
What does good look like? (良いものは?) パターン |
|---|---|
| Data 360 | 組織 | ✅ プラットフォームイベントとのデータアクションを使用した既存のインテグレーションパターンの再利用 プラットフォームイベントの活用 既存の Pub Sub API およびイベントリレーインテグレーションを活用した外部システムでのデータアクションの使用 |
| プラットフォーム | Apex | ✅ カスタムイベント定義の範囲は制限されます (システム全体のイベントやメッセージはコードで定義されません) |
| プラットフォーム | Apex | ✅ Apex のシステム全体のメッセージング サービスまたはイベント サービスには、Salesforce フロー ツールで使用できるようにアノテーションが付けられます。 |
| プラットフォーム | 設計標準 | ✅ 同期パターン (メッセージング) と非同期パターン (イベント) の明確な標準が存在する |
| プラットフォーム | 設計標準 | ✅ イベントやメッセージの構造には明確な基準がある |
| プラットフォーム | フロー | ✅ Salesforce フローツールは、システム全体のメッセージングまたはイベントサービスを参照します。 |
| プラットフォーム | LWC(Lightning Web コンポーネント) | ✅ カスタムイベント定義の範囲は制限されます (システム全体のイベントやメッセージはコードで定義されません) |
| プラットフォーム | 組織 | ✅ 一貫したメッセージングとイベントパターンがフローとコードに表示される |
| プラットフォーム | プラットフォームイベント | ✅ 内部システムメッセージングで使用されるプラットフォームイベントの表示ラベルが明確になっている |
API 管理アンチパターン
[Well-Architected Adaptable (適切に設計された適応可能)] → [Composable (構成可能)] → [Interoperability (相互運用性)] → [API Management (API 管理)] の詳細
| Where to look? 商品領域 | ロケーション |
What to avoid? アンチパターン |
|---|---|
| プラットフォーム | ビジネス | ⚠️ クライアントアプリケーションが古い API バージョンを使用して Salesforce Platform API をコールする Salesforce クライアントアプリケーションは、使用している API バージョンを定期的に最新バージョンに更新する必要があります。 |
| プラットフォーム | 設計標準 | ⚠️ 設計標準が存在しないか、API と使用事例を定義していない |
| プラットフォーム | ドキュメント | ⚠️ コンポーネントのドキュメントが存在しない |
| プラットフォーム | ドキュメント | ⚠️ コンポーネントドキュメントにはコンポーネント内に実装された API が記述されていますが、API 定義が表示されるのはここのみです。 |
| プラットフォーム | ドキュメント | ⚠️ 特定の API またはプロトコルを検索することはできず、検索は API またはプロトコルが実装されたコンポーネントの識別に役立ちません。 |
| プラットフォーム | 組織 | ⚠️ API は、Salesforce と外部システム間の通信専用に定義されています。 |
| プラットフォーム | 組織 | ⚠️ システムのコンポーネント間 (コードおよび宣言型カスタマイズ) の通信がアドホックである |
メッセージングおよびイベント対策パターン
適切に設計された適応性 → 構成可能 → 相互運用性 → メッセージングとイベントについての詳細
| Where to look? 商品領域 | ロケーション |
What to avoid? アンチパターン |
|---|---|
| プラットフォーム | Apex | ⚠️ システム全体のメッセージやイベントの構造がコードで定義されている |
| プラットフォーム | Apex | ⚠️ Apex で定義されたシステム全体のイベント構造またはメッセージ構造をフローなどのツールで使用できない |
| プラットフォーム | 設計標準 | ⚠️ 設計標準が存在しないか、同期パターンと非同期パターンの明確な標準やメッセージまたはイベント構造の明確な標準がない |
| プラットフォーム | LWC(Lightning Web コンポーネント) | ⚠️ システム全体のメッセージやイベントの構造がコードで定義されている |
| プラットフォーム | 組織 | ⚠️ メッセージングとイベントパターンのさまざまな戦略がフローとコードで表示される |
| プラットフォーム | プラットフォームイベント | ⚠️ 内部システムメッセージングに使用されるプラットフォームイベントの表示ラベルが明確でない、または存在しない |