Centra-se nos princípios e práticas de conceção de APIs.
Station
Garantia de qualidade e prontidão
Audite o contrato de interface, os controlos, o modelo de suporte, a observabilidade, a documentação e a prontidão de ciclo de vida da capacidade antes da disponibilização.
As capacidades reutilizáveis criam riscos operacionais, de dados, segurança, privacidade, conformidade e impacto nos consumidores. As verificações de prontidão reduzem surpresas antes da publicação ou utilização em produção.
Sua rota no mapa
Mapa do metrô
Select a cycle, station, or stakeholder to open its permanent method page.
Selected station: Auditoria de API - Auditoria de APIs para conformidade e qualidade
Pessoas a envolver
Recursos relacionados
Resultados
- Prontidão para disponibilização e reutilização documentada
- Lacunas e mitigações conhecidas antes da publicação
- Evidências para aprovação de governação, conformidade, suporte e operações
- Risco reduzido de problemas em produção
Critérios do percurso
Critérios de entrada
- A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma.
- A interface selecionada fornece uma abstração adequada aos utilizadores.
- O desenho da interface e as capacidades expostas são rastreáveis ao valor de negócio e às necessidades dos utilizadores.
- O desenho da interface segue os standards e convenções de desenho acordados.
Critérios de saída
- A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma.
- O desenho da interface e as capacidades expostas são rastreáveis ao valor de negócio e às necessidades dos utilizadores.
- A interface e as suas capacidades estão documentadas de forma suficientemente clara para revisão, auditoria e onboarding.
- O desenho da interface segue os standards e convenções de desenho acordados.
- O contrato de interface foi validado e testado face aos requisitos funcionais e não funcionais.
Como é o sucesso na prática
Utilize recursos de auditoria e conformidade para verificar que a capacidade está pronta para disponibilização controlada e reutilização.
- Utilize a lista de verificação de auditoria como checklist de qualidade reutilizável para contrato de interface, documentação, segurança, desempenho e prontidão de conformidade. — Lista de verificação de auditoria da API
- Utilize checklists, linters e ferramentas de teste para verificar consistência e conformidade com normas.
- Colabore com equipas de governação e especialistas de domínio para garantir que a capacidade está pronta para produção.
Metro lines
Centra-se na publicação de APIs e na garantia da sua adoção pelos consumidores.
Recursos relacionados
Browse the resources selected for Garantia de qualidade e prontidão; the summary above explains how they support this station’s work.
Recursos
Resources for Garantia de qualidade e prontidão
checklist
Lista de verificação de auditoria da API
Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.
Resultados
- Melhor compreensão dos princípios da lista de controlo de auditoria da API
- Abordagem normalizada utilizando a lista de verificação de auditoria da API
- Melhoria da implementação das práticas de API relacionadas
Como funciona
- Utilize a lista de verificação de auditoria da API para garantir que a conceção da API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
- Realize auditorias para avaliar a cobertura do ciclo de vida e verificar se a API satisfaz os padrões de negócio, conceção e operacionais.
- Certifique-se de que a documentação, os modelos de segurança, a configuração do gateway e os requisitos legais estejam claramente definidos, validados e comprovados por evidências.
Relevant cycles
Ciclo de Produto de Capacidades
Um ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.
Ciclo de Produto de API
A jornada APIOps Cycles focada em API para transformar APIs em produto, concebê-las, entregá-las, publicá-las e melhorá-las.
Ciclo de Produto de Integração
Um ciclo para transformar capacidades de integracao reutilizaveis em produto antes de selecionar o estilo de implementacao.
Ciclo de Automação
Um ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automação.