Station

Conceção da solução de integração

Conceber o contrato de interface, os esquemas, os payloads e os padroes de interacao para o estilo de integracao selecionado.

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

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égicos1Estratégia da capacidadede integraçãoExperiência do consumidor da API - Conceção para os utilizadores reais da sua API2Requisitos e integraçãode consumidores daintegraçãoArquitetura da plataforma API - Arquitetar APIs para escalabilidade e reutilização3Arquitetura deintegracao e decisoes deplataformaConceção da API - Conceber APIs que proporcionem valor4Conceção da solução deintegraçãoEntrega da API - Fornecer APIs seguras e fiáveis5Entrega e operações daintegraçãoAuditoria de API - Auditoria de APIs para conformidade e qualidade6Garantia de prontidão daintegraçãoPublicação de API - Publique APIs com confiança7Publicacao e enablementda integracaoMonitorização e melhoria - para valor API8Monitorização e melhoriada integraçãoLinha 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

  • 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.

Como é o sucesso na prática

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.

  1. Definir entidades principais, os seus atributos e relações para criar um entendimento concetual partilhado entre APIs. — Canvas de Domínio
  2. 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. — Canvas de Interação
  3. Aplicar padrões de conceção REST para criar contratos de interface da API consistentes e reutilizáveis que são validados com as partes interessadas. — Canvas REST
  4. Aplicar padrões de conceção orientados para eventos para criar contratos de interface da API consistentes e reutilizáveis que são validados com as partes interessadas. — Canvas de Eventos
  5. Aplicar padrões de conceção GraphQL para criar contratos de interface da API consistentes e reutilizáveis que são validados com as partes interessadas.
  6. Utilize os princípios de projeto e o guia de estilo da API para alinhar suas decisões de projeto com regras compartilhadas e permitir uma validação de auditoria consistente. — Princípios de conceção da API
  7. Aplique abordagens do tipo ‘contrato primeiro’ ou ‘design primeiro’ para capturar e validar o contrato de interface da API antes da implementação.
  8. Utilize a Lista de Verificação de Auditoria da API para garantir que a conceção da API satisfaça os 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 de integração; the summary above explains how they support this station’s work.

Recursos

Resources for Conceção da solução de integração

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.