Centra-se nos princípios e práticas de conceção de APIs.
Station
Revisão de prontidão da automação
Reveja a prontidão, a qualidade, o risco, a conformidade, a supervisão humana, as evidências e os critérios de disponibilização da automação.
As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposiçã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
- As APIs cumprems normas internas e externas
- Documentação clara das decisões de conceção e implementação da API
- Segurança, desempenho e conformidade validados
- Redução do risco de problemas na 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
Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.
- Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação. — Lista de verificação de auditoria da API
- Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.
- Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas 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 Revisão de prontidão da automação; the summary above explains how they support this station’s work.
Recursos
Resources for Revisão de prontidão da automaçã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.