Conceção de API bem documentada e coerente
Criar projetos de API que sejam consistentes, reutilizáveis e baseados na intenção de negócios e em padrões compartilhados.
Projetar APIs não se resume apenas a nomear endpoints. Um bom projeto garante que as APIs sejam utilizáveis, consistentes e alinhadas com os objetivos comerciais e técnicos. Um projeto inadequado leva a um acoplamento rígido, baixa reutilização e retrabalho dispendioso entre as equipes.
Forneça padrões de projeto reutilizáveis, padrões compartilhados e ferramentas de validação para especificações de API. Garanta que as decisões de projeto sejam consistentes, revisadas antecipadamente e alinhadas com a intenção de negócios.
Etapa1/8
Uma ferramenta de modelação para definir e comunicar as principais entidades e relações no seu domínio, assegurando a consistência semântica entre APIs.
Definir entidades principais, os seus atributos e relações para criar um entendimento concetual partilhado entre APIs.
Etapa2/8
Definir interações API, fluxos de trabalho e respostas esperadas para garantir uma experiência consistente do consumidor API.
Utilize o Canvas de Interação para definir a forma como os consumidores irão interagir com a API, garantindo que esta satisfaz as suas necessidades e expectativas.
Etapa3/8
Conceber APIs utilizando os princípios RESTful, definindo recursos, verbos e exemplos de pedidos e respostas.
Aplicar padrões de conceção REST para criar contratos de API consistentes e reutilizáveis que são validados com as partes interessadas.
Etapa4/8
Conceber APIs orientadas para eventos, definindo eventos, accionadores e lógica de processamento.
Aplicar padrões de conceção orientados para eventos para criar contratos de API consistentes e reutilizáveis que são validados com as partes interessadas.
Etapa5/8
Conceber APIs GraphQL definindo tipos, consultas, mutações e subscrições.
Aplicar padrões de design GraphQL para criar contratos de API consistentes e reutilizáveis que são validados com as partes interessadas.
Etapa6/8
Um guia conciso sobre usabilidade, descobribilidade e consistência da API, baseado em regras de design compartilhadas e nas necessidades reais dos consumidores.
Use os princípios de projeto e o guia de estilo de API para alinhar suas decisões de projeto com regras compartilhadas e permitir uma validação de auditoria consistente.
Etapa7/8
Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.
Aplique abordagens do tipo ‘contrato primeiro’ ou ‘design primeiro’ para capturar e validar o contrato da API antes da implementação.
Etapa8/8
Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade usando critérios de auditoria e evidências definidos.
Use a Lista de Verificação de Auditoria da API para garantir que o design da API atenda aos requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
