Design consistente da API em toda a organização
Estabelecer normas e diretrizes de design para garantir um design API consistente e de alta qualidade em toda a organização.
Um design de API consistente e de alta qualidade é essencial para a usabilidade, manutenção e escalabilidade. Esta estação fornece normas e diretrizes de design que ajudam as equipas a criar APIs que são fáceis de utilizar, compreender e manter.
Fornecer documentação sobre normas de conceção, componentes reutilizáveis e processos de revisão da conceção. Assegurar que as equipas seguem as normas de conceção e realizam revisões regulares para manter uma conceção de API de alta qualidade.
Etapa1/3
Um guia conciso sobre usabilidade, descobribilidade e consistência da API, baseado em regras de design compartilhadas e nas necessidades reais dos consumidores.
Definir normas e diretrizes de conceção para a conceção de API, incluindo convenções de nomenclatura, formatos de resposta e tratamento de erros.
Etapa2/3
Criar padrões de conceção e componentes reutilizáveis que as equipas possam utilizar para garantir a consistência e a qualidade.
Etapa3/3
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.
Efetuar revisões e auditorias de conceção para garantir o cumprimento das normas de conceção e identificar áreas a melhorar.
