Padrão de gerenciamento de API
Saiba mais sobre Well-Architected Adaptable → Composable → Interoperability → API Management
| Onde procurar? Área de produtos | Local |
Qual é a aparência de um bom? Padrão |
|---|---|
| Plataforma | Negócios | ✅ Os aplicativos cliente usam a versão mais recente da API para chamar aplicativos do Salesforce Client que chamam APIs da Salesforce Platform atualizam regularmente a versão da API que estão usando |
| Plataforma | Padrões de design | ✅ Existem protocolos claros para comunicação entre componentes (ou seja, APIs) |
| Plataforma | Padrões de design | ✅ Os protocolos/APIs são descritos em grupos lógicos que os criadores podem pesquisar e localizar |
| Plataforma | Padrões de design | ✅ Os protocolos/APIs definem tipos de dados variáveis, nomes de variáveis, o que é obrigatório ou opcional e fornecem uma descrição clara de quando usar |
| Plataforma | Documentação | ✅ É possível pesquisar uma API ou protocolo específico e identificar componentes em que ele é implementado |
| Plataforma | Documentação | ✅ A documentação de cada componente lista claramente qual protocolo de API/comunicação foi implementado |
| Plataforma | Organização | ✅ Formatos de mensagem da API e variáveis para comunicação interna são definidos com tipos de metadados personalizados |
| Plataforma | Organização | ✅ Formatos de mensagem da API e variáveis para comunicação interna são definidos com eventos de plataforma |
| Plataforma | Organização | ✅ Personalizações declarativas e de código fazem referência ao tipo de metadados personalizados apropriado (ou evento de plataforma) para enviar ou receber informações |
Padrão de mensagens e compromissos
Saiba mais sobre Well-Architected Adaptable → Composable → Interoperabilidade → Mensagens e Eventos
| Onde procurar? Área de produtos | Local |
Qual é a aparência de um bom? Padrão |
|---|---|
| Data 360 | Organização | ✅ Usar ações de dados com eventos de plataforma para reutilizar padrões de integração existentes Aproveitar eventos de plataforma para disponibilizar ações de dados a sistemas externos aproveitar as integrações existentes de API Pub Sub e Retransmissão de evento |
| Plataforma | Apex | ✅ Definições de evento personalizadas têm escopo limitado (nenhum evento ou mensagem de todo o sistema é definido em código) |
| Plataforma | Apex | ✅ Serviços de mensagens ou eventos em todo o sistema no Apex são anotados de maneiras que os tornam disponíveis nas ferramentas do Salesforce Flow |
| Plataforma | Padrões de design | ✅ Existem padrões claros para quando usar padrões síncronos (messaging) e padrões assíncronos (eventing) |
| Plataforma | Padrões de design | ✅ Existem padrões claros para estruturas de eventos e mensagens |
| Plataforma | Fluxo | ✅ Ferramentas do Salesforce Flow fazem referência a serviços de mensagens ou compromissos de todo o sistema |
| Plataforma | Componentes da Web Lightning (LWC) | ✅ Definições de evento personalizadas têm escopo limitado (nenhum evento ou mensagem de todo o sistema é definido em código) |
| Plataforma | Organização | ✅ Padrões consistentes de mensagens e compromissos aparecem em fluxos e códigos |
| Plataforma | Eventos de plataforma | ✅ Eventos de plataforma usados para mensagens internas do sistema são rotulados claramente |
Antipadrão de gerenciamento de API
Saiba mais sobre Well-Architected Adaptable → Composable → Interoperability → API Management
| Onde procurar? Área de produtos | Local |
O que evitar? Antipadrão |
|---|---|
| Plataforma | Negócios | ⚡️ Os aplicativos cliente usam versões de API desatualizadas para chamar aplicativos Salesforce Client que chamam APIs da Salesforce Platform precisam atualizar regularmente a versão da API que estão usando para a versão mais recente |
| Plataforma | Padrões de design | ⚡️ Os padrões de design não existem ou não definem APIs e casos de uso |
| Plataforma | Documentação | ⚡️ A documentação do componente não existe |
| Plataforma | Documentação | A documentação do componente descreve a API implementada em um componente, mas esse é o único lugar em que a definição da API aparece |
| Plataforma | Documentação | ⚡️ Não é possível pesquisar uma API ou protocolo específico e/ou as pesquisas não ajudam a identificar componentes em que uma API ou protocolo foi implementado |
| Plataforma | Organização | As APIs são definidas exclusivamente para comunicação entre o Salesforce e sistemas externos |
| Plataforma | Organização | A comunicação entre componentes do sistema (código e personalizações declarativas) é ad hoc |
Antipadrão de mensagens e eventos
Saiba mais sobre Well-Architected Adaptable → Composable → Interoperabilidade → Mensagens e Eventos
| Onde procurar? Área de produtos | Local |
O que evitar? Antipadrão |
|---|---|
| Plataforma | Apex | Estruturas de eventos e/ou mensagens de todo o sistema são definidas em código |
| Plataforma | Apex | Estruturas de mensagens ou eventos de todo o sistema definidas no Apex não estão disponíveis em ferramentas como fluxo |
| Plataforma | Padrões de design | ⚡️ Não existem padrões de design ou eles não têm padrões claros para padrões de sincronização vs. assíncronos e padrões claros para estruturas de mensagem ou evento |
| Plataforma | Componentes da Web Lightning (LWC) | Estruturas de eventos e/ou mensagens de todo o sistema são definidas em código |
| Plataforma | Organização | Diferentes estratégias para mensagens e padrões de ocorrência aparecem em fluxo e código |
| Plataforma | Eventos de plataforma | Eventos de plataforma usados para mensagens internas do sistema não são rotulados claramente ou não existem |