Pessoas a envolver

Designer API

Modela o contrato de interface, o modelo de interação, a consistência e a usabilidade das capacidades expostas.

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.

Relevant stations

Decisions and outputs

Decisions

  • Definir entidades principais, os seus atributos e relações para criar um entendimento concetual partilhado entre APIs.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.

Outputs

  • 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
  • spec
  • contract
  • design-artifact
  • documentation

Recommended resources

Facilitate as Designer API

Use these prepared prompts alongside the stakeholder decisions, outputs, stations, and resources summarized above.

Usar com IA

Facilitar discussão da estação

Facilitate a station with Designer API

facilitate-station

Stakeholder: Designer API
Cycles: Ciclo de Produto de Capacidades, Ciclo de Produto de API, Ciclo de Produto de Integração, Ciclo de Automação
Stations: Conceção da API - Conceber APIs que proporcionem valor, Entrega da API - Fornecer APIs seguras e fiáveis, Auditoria de API - Auditoria de APIs para conformidade e qualidade, Experiência do consumidor da API - Conceção para os utilizadores reais da sua API
Resources and canvases: Canvas de Domínio, Canvas de Interação, Canvas de Requisitos da Experiência do Utilizador, Canvas REST, Canvas de Eventos, Canvas GraphQL, Canvas da Proposta de Valor da API, Canvas do Percurso do Cliente

Act as an APIOps Cycles facilitator. Use the selected station questions, entry criteria, exit criteria, stakeholders, and related resources to guide the discussion. Produce decisions, evidence gaps, and next steps.