Fornecimento de API

Criar, testar e lançar APIs usando pipelines de entrega modernos e práticas recomendadas de engenharia.

Resultados

• APIs implementadas utilizando estruturas e padrões testados

Linhas de metrô relacionadas

• Linha de conceção API
• Linha de entrega

Porque é importante

Mesmo os melhores projectos de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.

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 objetivo da API é ocultar modelos de dados de back-end e discrepâncias.
• O design e os pontos finais da API têm uma conexão clara com seu valor comercial e recursos.
• A API tem um design consistente com nossos outros produtos API.

Critérios de saída

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

Como funciona

1. Utilizar estruturas e bibliotecas estabelecidas para implementar APIs, assegurando a sua reutilização e manutenção.
   Melhores práticas de desenvolvimento de API Diretrizes que promovem bases de código API consistentes e passíveis de manutenção, utilizando bibliotecas normalizadas, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.
2. Aplicar abordagens “contract-first” ou “design-first” para garantir que os contratos API são validados antes da implementação.
   Primeira conceção do contrato Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.
3. Testar a funcionalidade, a segurança e o desempenho das API, utilizando ferramentas de teste automatizadas.
   Melhores práticas de teste de API Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.
4. Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.
   APIOps CI/CD para APIs Orientação de implantação que integra tarefas do ciclo de vida da API - design, teste, governança - em pipelines de integração e entrega contínuas.
5. Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.
   Melhores práticas de segurança da API Um conjunto de controlos acionáveis para proteger APIs, incluindo autenticação, autorização, encriptação, limitação de taxas e verificações de conformidade ao nível do pipeline.
6. Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
   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

Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da implantação.