QuemNão selecionadoPor quêNão selecionadoOndeConceção da APICicloCiclo de Produto de APILinha de conceção de API

Estação

Conceção da API

Criar conceções de API que sejam consistentes, reutilizáveis e baseados na intenção de negócios e em padrões compartilhados.

Conceber 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 de negócio e técnicos. Um projeto inadequado leva a um acoplamento rígido, baixa reutilização e retrabalho dispendioso entre as equipas.

Sua rota no mapa

Navegar pelo método

Selecione uma estação, ciclo ou perspectiva para explorar o método.

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égicos1Estratégia de produtoAPIExperiência do consumidor da API - Conceção para os utilizadores reais da sua API2Experiência doconsumidor da APIArquitetura da plataforma API - Arquitetar APIs para escalabilidade e reutilização3Arquitetura daplataforma APIConceção da API - Conceber APIs que proporcionem valor4Conceção da APIEntrega da API - Fornecer APIs seguras e fiáveis5Entrega da APIAuditoria de API - Auditoria de APIs para conformidade e qualidade6Auditoria da APIPublicação de API - Publique APIs com confiança7Publicação da APIMonitorização e melhoria - para valor API8Monitorizacao e melhoriada APILinha oportunidades de negócioLinha de arquitetura da plataformaLinha de conceção de APILinha de entregaLinha de publicação e adoçãoLinha de modelo operacional

Resultados

  • Conceção de API bem documentada e coerente
  • Contratos de interface da API reutilizáveis e validados
  • Desenhos alinhados com modelos de domínio e padrões de interação
  • Rastreabilidade da conceção ao valor de negócio

Critérios do percurso

Critérios de entrada

  • A capacidade responde a uma necessidade clara de negócio e é reutilizável pelos utilizadores previstos.
  • A interface selecionada fornece uma abstração adequada aos utilizadores.
  • A proposta de valor da capacidade foi validada com partes interessadas de negócio e utilizadores.
  • Os segmentos de utilizadores estão identificados.
  • Está definido um roadmap de implementação de alto nível.

Critérios de saída

  • A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma.
  • A interface selecionada fornece uma abstração adequada aos utilizadores.
  • O desenho da interface e as capacidades expostas são rastreáveis ao valor de negócio e às necessidades dos utilizadores.
  • O desenho da interface segue os standards e convenções de desenho acordados.

Pessoas a envolver

Recursos relacionados

canvasCanvas de InteraçãoDefinir interações API, fluxos de trabalho e respostas esperadas para garantir uma experiência consistente do utilizador API.canvasCanvas RESTConceber APIs utilizando os princípios RESTful, definindo recursos, verbos e exemplos de pedidos e respostas.canvasCanvas de EventosConceber APIs orientadas para eventos, definindo eventos, accionadores e lógica de processamento.guidelinePrincípios de conceção da APIUm guia conciso sobre usabilidade, descobribilidade e consistência da API, baseado em regras de design partilhadas e nas necessidades reais dos utilizadores.canvasCanvas de DomínioUma 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.

Linhas de metrô