Station

Normas de conceção - Garantir uma conceção de API consistente e de alta qualidade

Estabelecer normas e diretrizes de design para garantir um design API consistente e de alta qualidade em toda a organização.

Um conceção 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.

Sua rota no mapa

Mapa do metrô

Select a cycle, station, or stakeholder to open its permanent method page.

EstratégicoGovernançaConsumidorTécnicoExperiência do utilizadorExperiência do utilizadorInformações sobre o mercadoInformações sobre o mercadoObjectivos comerciaisObjectivos comerciaisAnálise competitivaAnálise competitivaVisão do ecossistemaVisão do ecossistemaInfraestrutura escalávelInfraestrutura escalávelLegal e ConformidadeLegal e ConformidadeSegurança e privacidadeSegurança e privacidadeNormas de conceçãoNormas de conceçãoGestão de fornecedoresGestão de fornecedoresConceção de contratosConceção de contratosDesenvolvimentoDesenvolvimentoCI/CDCI/CDAutomatização de testesAutomatização de testesGestão de versõesGestão de versõesAcordos de serviçoAcordos de serviçoAdoção pelo consumidor da APIAdoção pelo consumidor da APIPromoção da APIPromoção da APIIntegração de parceirosIntegração de parceirosMentalidade APIMentalidade APIFunções e responsabilidadesFunções e responsabilidadesUpskillingUpskillingDiretrizes operacionaisDiretrizes operacionaisGestão de portfólioGestão de portfólioOrçamento e gestão de recursosOrçamento e gestão de recursosEstratégia de produtos API - Transforme APIs em produtos estratégicos1Estrategia da capacidadeExperiência do consumidor da API - Conceção para os utilizadores reais da sua API2Requisitos e onboardingde utilizadoresArquitetura da plataforma API - Arquitetar APIs para escalabilidade e reutilização3Decisões de arquiteturae plataformaConceção da API - Conceber APIs que proporcionem valor4Conceção da solução e dainterfaceEntrega da API - Fornecer APIs seguras e fiáveis5Entrega e operaçõesAuditoria de API - Auditoria de APIs para conformidade e qualidade6Garantia de qualidade eprontidãoPublicação de API - Publique APIs com confiança7Publicacao e enablementMonitorização e melhoria - para valor API8Monitorização e melhoriaLinha oportunidades de negócioLinha de arquitetura da plataformaLinha de conceção de APILinha de entregaLinha de publicação e adoçãoLinha de modelo operacional

Selected station: Normas de conceção - Garantir uma conceção de API consistente e de alta qualidade

Pessoas a envolver

Recursos relacionados

Resultados

  • Conceção consistente da API em toda a organização
  • APIs de alta qualidade que satisfazem as necessidades dos utilizadores
  • Componentes e padrões de conceção reutilizáveis
  • Redução das inconsistências de conceção e da dívida técnica

Critérios do percurso

Critérios de entrada

Critérios de saída

Como é o sucesso na prática

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.

  1. 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. — Princípios de conceção da API
  2. Criar padrões de conceção e componentes reutilizáveis que as equipas possam utilizar para garantir a consistência e a qualidade.
  3. Efetuar revisões e auditorias de conceção para garantir o cumprimento das normas de conceção e identificar áreas a melhorar. — Lista de verificação de auditoria da API

Metro lines

Recursos relacionados

Browse the resources selected for Normas de conceção - Garantir uma conceção de API consistente e de alta qualidade; the summary above explains how they support this station’s work.

Recursos

Resources for Normas de conceção - Garantir uma conceção de API consistente e de alta qualidade

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

  1. 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.
  2. 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.
  3. 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