Publicação de API

Exponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos.

Resultados

• APIs publicadas no ambiente correto (privado, parceiro, público)

Linhas de metrô relacionadas

• Linha de publicação e adoção

Porque é importante

A publicação é mais do que a implantação - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.

Critérios de entrada

• A API é aprovada nas verificações de conformidade, segurança e auditoria.
• Os relatórios de auditoria são compartilhados com as partes interessadas.
• A API está pronta para ser publicada nos gateways e ambientes apropriados para oferecer suporte à reutilização por vários consumidores de API.
• A documentação da API está completa e pronta para publicação.

Critérios de saída

• A documentação da API está completa e pronta para publicação.
• Os processos de registro, suporte e comunicação da API estão em vigor.
• Os requisitos legais e de conformidade são precisos o suficiente para publicação.

Como funciona

1. Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.
2. Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.
   Melhores práticas de integração de API Práticas recomendadas para simplificar as jornadas de integração do consumidor da API com registo passo a passo, descoberta e orientação na primeira chamada.
3. Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores.
   Lista de verificação de auditoria da API Uma lista de verificação abrangente para verificar a prontidão da API antes da publicação, abrangendo o design, a documentação, a segurança e a conformidade com a política.

Aplicar no seu trabalho

Permitir que as API sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.