Auditoria de API

Validar se as APIs cumprem as normas organizacionais, técnicas e legais antes da publicação.

Resultados

• As APIs cumprem as normas internas e externas

Linhas de metrô relacionadas

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

Porque é importante

As APIs são produtos de longa duração e precisam de cumprir as expectativas de qualidade, consistência e conformidade. As auditorias reduzem os riscos, evitam que os defeitos cheguem à produção e apoiam as certificações externas.

Critérios de entrada

• A arquitetura da API usa padrões que promovem a reutilização e a integração e é validada pelas partes interessadas.
• O design e os pontos finais da API têm uma conexão clara com seu valor comercial e recursos.
• A API e seus pontos finais têm descrições que explicam seu valor comercial e recursos.
• A API tem um design consistente com nossos outros produtos API.
• O contrato da API é testado e atende aos requisitos funcionais e não funcionais.

Critérios de saída

• 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.

Como funciona

1. Realizar auditorias para garantir que as APIs cumprem as normas organizacionais, técnicas e legais antes da publicação.
   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.
2. Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.
   Melhores práticas de conformidade da API Garantir que as APIs cumprem a conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.
3. Colaborar com as equipas de governação e especialistas no domínio para garantir que as API estão prontas para produção.

Aplicar no seu trabalho

Criar estruturas e ferramentas de governação para validar a conformidade, o desempenho e a segurança da API. Monitorizar se as APIs cumprem os critérios de validação.