# Entrega da API - Fornecer APIs seguras e fiáveis Canonical page: https://apiopscycles.com/pt/stations/api-delivery Language: pt Entity ID: api-delivery ## Description Criar, testar e lançar APIs usando pipelines de entrega modernos e boas práticas de engenharia. ## Why it matters Mesmo os melhores conceções 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. ## Apply in work 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 disponibilização. ## Outcomes - APIs implementadas utilizando estruturas e padrões testados - Pipelines de CI/CD fiáveis e automatizados - Testes funcionais e não funcionais integrados - Condutas de entrega seguras e conformes ## Steps 1. Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável. 2. Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos. 3. Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas. 4. Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes. 5. Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas. 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. ## Questions - Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável. - Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos. - Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas. - Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes. - Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas. - 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. - 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 disponibilização. - Mesmo os melhores conceções 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. ## Evidence - implementation - pipeline-config - test-report - security-report ## Completion criteria - A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma. — The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders. (ID: architecture-patterns-validated) - A interface selecionada fornece uma abstração adequada aos utilizadores. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies) - O desenho da interface e as capacidades expostas são rastreáveis ao valor de negócio e às necessidades dos utilizadores. — The API design and exposed capabilities clearly trace back to business value and user needs. (ID: design-reflects-business-value) - O desenho da interface segue os standards e convenções de desenho acordados. — The API design follows our shared API product and design conventions. (ID: api-consistency) ## Role participation and responsibilities - [Engenheiro de automatização](https://apiopscycles.com/pt/roles/automation-engineer.md) (lead): Implementa, testa, integra e mantém soluções de automatização e workflows de suporte. - [Engenheiro de entrega](https://apiopscycles.com/pt/roles/api-engineer.md) (lead): Responsável pela implementação, automatização, testes e fluxo de publicação necessários para entregar a capacidade, API ou automatização de forma fiável.; suggested-answer-owner: [Canvas de prontidão e operações da capacidade](https://apiopscycles.com/pt/resources/capability-readiness-operations-canvas.md) - [Arquiteto de integração](https://apiopscycles.com/pt/roles/integration-architect.md) (core): Desenha abordagens de integração e estilos de implementação que ligam a capacidade ou API a outros sistemas. - [Arquiteto de plataforma](https://apiopscycles.com/pt/roles/platform-architect.md) (core): Orienta decisões de plataforma, integração, escalabilidade e arquitetura que moldam como a capacidade ou API é construída e operada. - [Designer API](https://apiopscycles.com/pt/roles/api-designer.md) (core): Modela o contrato de interface, o modelo de interação, a consistência e a usabilidade das capacidades expostas. - [Especialista em segurança](https://apiopscycles.com/pt/roles/security-specialist.md) (core): Garante que os riscos de segurança, controlos e fronteiras de confiança são tratados ao longo de todo o ciclo de vida. - [Responsável pela automatização](https://apiopscycles.com/pt/roles/automation-owner.md) (core): Responsável pelos objetivos, valor de negócio, prioridades, controlos e resultados do ciclo de vida da automatização.; suggested-answer-owner: [Canvas de prontidão e operações de automação](https://apiopscycles.com/pt/resources/automation-readiness-operations-canvas.md) - [Responsável por suporte e operações](https://apiopscycles.com/pt/roles/operations-specialist.md) (core): Representa o suporte em execução, tratamento de incidentes, observabilidade e prontidão operacional da capacidade, API ou automatização. - [Especialista em conformidade e jurídico](https://apiopscycles.com/pt/roles/compliance-specialist.md) (consulted): Esclarece requisitos legais, de privacidade, regulamentares e contratuais que afetam a capacidade, API, interface ou automatização. - [Gestor de parceiros ou fornecedores](https://apiopscycles.com/pt/roles/partner-specialist.md) (consulted): Coordena relações com parceiros, fornecedores ou prestadores externos que influenciam a estratégia e entrega da capacidade ou API. - [Responsável de negócio](https://apiopscycles.com/pt/roles/business-owner.md) (consulted): Representa os objetivos de negócio, o financiamento e os resultados esperados da iniciativa de capacidade, API ou automatização. - [Responsável pela capacidade](https://apiopscycles.com/pt/roles/capability-owner.md) (consulted): Responsável pela visão, valor, prioridades, ciclo de vida e reutilização da capacidade junto dos utilizadores. - [Responsável pelo processo](https://apiopscycles.com/pt/roles/process-owner.md) (consulted): Responsável pelo processo de negócio a automatizar, incluindo objetivos, regras, resultados e prioridades de melhoria. - [Responsável pelo produto API](https://apiopscycles.com/pt/roles/api-product-owner.md) (consulted): Conduz a oportunidade API, a priorização e as decisões ao nível do produto ao longo do ciclo de vida. ## Cycle-specific guidance - [Ciclo de Produto de Capacidades](https://apiopscycles.com/pt/cycles/capability-productization-cycle/stations/api-delivery.md) - [Ciclo de Produto de API](https://apiopscycles.com/pt/cycles/api-productization-cycle/stations/api-delivery.md) - [Ciclo de Produto de Integração](https://apiopscycles.com/pt/cycles/integration-productization-cycle/stations/api-delivery.md) - [Ciclo de Automação](https://apiopscycles.com/pt/cycles/automation-cycle/stations/api-delivery.md)