Station

Conceção da solução e da interface

Conceba o contrato de interface e o modelo de interação para o estilo de disponibilização selecionado.

Depois de conhecido o padrão de arquitetura, a conceção deve transformar os requisitos da capacidade em contratos de interface, interações, esquemas, regras de dados, expectativas de ciclo de vida e obrigações dos consumidores claros.

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: Conceção da API - Conceber APIs que proporcionem valor

Pessoas a envolver

Recursos relacionados

Resultados

  • Um contrato de interface validado para o estilo de disponibilização selecionado
  • Decisões consistentes sobre interação, dados, eventos, ficheiros, fluxos de trabalho ou contratos de API
  • Rastreabilidade da conceção até aos requisitos da capacidade e dos consumidores
  • Conceções alinhadas com modelos de domínio e padrões de interação

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.

Como é o sucesso na prática

Selecione os recursos de conceção adequados ao estilo de disponibilização escolhido e documente o contrato de interface antes da implementação.

  1. Reutilize o Canvas de Domínio para confirmar objetos de negócio, termos, regras e propriedade antes da conceção do contrato. — Canvas de Domínio
  2. Utilize o Canvas de Interação para descrever como consumidores, sistemas ou utilizadores interagem com a capacidade. — Canvas de Interação
  3. Utilize recursos de conceção REST quando a interface selecionada for uma API REST. — Canvas REST
  4. Utilize recursos de Canvas de Eventos quando a interface selecionada for orientada por eventos. — Canvas de Eventos
  5. Utilize recursos de conceção GraphQL quando a interface selecionada for GraphQL.
  6. Utilize os princípios de conceção e a orientação de estilo para alinhar decisões de conceção com regras partilhadas e permitir validação de auditoria consistente. — Princípios de conceção da API
  7. Aplique abordagens contract-first ou design-first para captar e validar o contrato de interface antes da implementação.
  8. Utilize a lista de verificação de auditoria para garantir que a conceção cumpre requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade. — Lista de verificação de auditoria da API

Metro lines

Recursos relacionados

Browse the resources selected for Conceção da solução e da interface; the summary above explains how they support this station’s work.

Recursos

Resources for Conceção da solução e da interface

canvas

Canvas de Interação

Definir interações API, fluxos de trabalho e respostas esperadas para garantir uma experiência consistente do utilizador API.

Resultados

  • Fluxos de trabalho de interação API claros
  • Entradas e saídas definidas para cada interação
  • Regras de validação consistentes em todas as interações

Como funciona

  1. Mapear as interações da API para as tarefas do utilizador
  2. Definir pontos finais para cada interação
  3. documentar os inputs e outputs de cada interação
  4. Especificar regras de validação e restrições
  5. Criar modelos de interação para interações CRUD, orientadas para a consulta, orientadas para o comando e orientadas para o evento

Relevant cycles

Ciclo de Produto de Capacidades

Um ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.

Ciclo de Produto de API

A jornada APIOps Cycles focada em API para transformar APIs em produto, concebê-las, entregá-las, publicá-las e melhorá-las.

Ciclo de Automação

Um ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automação.