API-Verwaltungsmuster
Erfahren Sie mehr über Gut entwickelte anpassungsfähige Elemente → Composable → Interoperability → API Management
| Wohin schauen? Produktbereich | Standort |
Wie sieht gut aus? Muster |
|---|---|
| Plattform | Unternehmen | ✅ Client-Anwendungen verwenden die neueste API-Version, um Salesforce-Client-Anwendungen aufzurufen, die Salesforce Platform-APIs aufrufen, und aktualisieren regelmäßig die von ihnen verwendete API-Version |
| Plattform | Designstandards | ✅ Es gibt klare Protokolle für die komponentenübergreifende Kommunikation (d.h. APIs) |
| Plattform | Designstandards | ✅ Protokolle/APIs werden in logischen Gruppen beschrieben, nach denen Ersteller suchen und suchen können |
| Plattform | Designstandards | ✅ Protokolle/APIs definieren Variablen-Datentypen, Variablennamen, erforderliche oder optionale Elemente und bieten eine klare Beschreibung der Verwendung |
| Plattform | Dokumentation | ✅ Es ist möglich, nach einer bestimmten API oder einem bestimmten Protokoll zu suchen und Komponenten zu identifizieren, in denen es implementiert ist |
| Plattform | Dokumentation | ✅ In der Dokumentation jeder Komponente ist klar aufgeführt, welches API-/Kommunikationsprotokoll implementiert wurde |
| Plattform | Organisation | ✅ API-Nachrichtenformate und Variablen für die interne Kommunikation werden mit benutzerdefinierten Metadatentypen definiert |
| Plattform | Organisation | ✅ API-Nachrichtenformate und Variablen für die interne Kommunikation werden mit Plattformereignissen definiert |
| Plattform | Organisation | ✅ Code und deklarative Anpassungen verweisen auf den entsprechenden benutzerdefinierten Metadatentyp (oder Plattformereignis), um Informationen zu senden oder zu empfangen |
Messaging- und Eventing-Muster
Erfahren Sie mehr über Gut durchdachte anpassungsfähige Funktionen → Composable → Interoperability → Messaging and Eventing
| Wohin schauen? Produktbereich | Standort |
Wie sieht gut aus? Muster |
|---|---|
| Data 360 | Organisation | ✅ Verwenden von Datenaktionen mit Plattformereignissen zum Wiederverwenden vorhandener Integrationsmuster Nutzen von Plattformereignissen zum Bereitstellen von Datenaktionen für externe Systeme Verwenden vorhandener Pub Sub API- und Ereignisweiterleitungsintegrationen |
| Platform | Apex | ✅ Benutzerdefinierte Ereignisdefinitionen sind im Umfang begrenzt (es sind keine systemweiten Ereignisse oder Nachrichten im Code definiert) |
| Platform | Apex | ✅ Systemweite Messaging- oder Eventing-Services in Apex sind so gekennzeichnet, dass sie in Salesforce-Flow-Tools verfügbar sind |
| Plattform | Designstandards | ✅ Es gibt klare Standards für die Verwendung synchroner Muster (Messaging) und asynchroner Muster (Abend) |
| Plattform | Designstandards | ✅ Es gibt klare Standards für Ereignis- und Nachrichtenstrukturen |
| Plattform | Flow | ✅ Salesforce-Flow-Tools verweisen auf systemweite Messaging- oder Eventing-Services |
| Plattform | Lightning Web Components (LWC) | ✅ Benutzerdefinierte Ereignisdefinitionen sind im Umfang begrenzt (es sind keine systemweiten Ereignisse oder Nachrichten im Code definiert) |
| Plattform | Organisation | ✅ Konsistente Messaging- und Ereignismuster werden in Flows und Code angezeigt |
| Plattform | Plattformereignisse | ✅ Plattformereignisse, die für interne Systemnachrichten verwendet werden, sind eindeutig gekennzeichnet |
Anti-Pattern der API-Verwaltung
Erfahren Sie mehr über Gut entwickelte anpassungsfähige Elemente → Composable → Interoperability → API Management
| Wohin schauen? Produktbereich | Standort |
Was vermeiden? Anti-Pattern |
|---|---|
| Plattform | Unternehmen | ⚠️ Client-Anwendungen verwenden veraltete API-Versionen, um Salesforce-Client-Anwendungen aufzurufen, die Salesforce Platform-APIs aufrufen, müssen die verwendete API-Version regelmäßig auf die neueste Version aktualisieren. |
| Plattform | Designstandards | ⚠️ Designstandards sind nicht vorhanden oder definieren keine APIs und Anwendungsfälle |
| Plattform | Dokumentation | ⚠️ Die Komponentendokumentation ist nicht vorhanden |
| Plattform | Dokumentation | ⚠️ In der Komponentendokumentation wird die in einer Komponente implementierte API beschrieben. Dies ist jedoch die einzige Stelle, an der die API-Definition angezeigt wird. |
| Plattform | Dokumentation | ⚠️ Es ist nicht möglich, nach einer bestimmten API oder einem bestimmten Protokoll zu suchen, und/oder Suchvorgänge helfen nicht, Komponenten zu identifizieren, bei denen eine API oder ein Protokoll implementiert wurde |
| Plattform | Organisation | ⚠️ APIs werden ausschließlich für die Kommunikation zwischen Salesforce und externen Systemen definiert |
| Plattform | Organisation | ⚠️ Die Kommunikation zwischen Komponenten des Systems (Code und deklarative Anpassungen) erfolgt ad hoc |
Anti-Pattern für Messaging und Eventing
Erfahren Sie mehr über Gut durchdachte anpassungsfähige Funktionen → Composable → Interoperability → Messaging and Eventing
| Wohin schauen? Produktbereich | Standort |
Was vermeiden? Anti-Pattern |
|---|---|
| Platform | Apex | ⚠️ Systemweite Nachrichten- und/oder Ereignisstrukturen werden im Code definiert |
| Platform | Apex | In Apex definierte systemweite Ereignis- oder Nachrichtenstrukturen sind in Tools wie Flow nicht verfügbar. |
| Plattform | Designstandards | ⚠️ Designstandards sind nicht vorhanden oder es fehlen klare Standards für Synchronisierungsmuster im Vergleich zu asynchronen Mustern und klare Standards für Nachrichten- oder Ereignisstrukturen. |
| Plattform | Lightning Web Components (LWC) | ⚠️ Systemweite Nachrichten- und/oder Ereignisstrukturen werden im Code definiert |
| Plattform | Organisation | ⚠️ Unterschiedliche Strategien für Messaging- und Eventing-Muster werden in Flow und Code angezeigt |
| Plattform | Plattformereignisse | ⚠️ Plattformereignisse, die für interne Systemnachrichten verwendet werden, sind nicht eindeutig gekennzeichnet oder nicht vorhanden |