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

Espaço local de canvas

Use the purpose, outcomes, and instructions above as your static reference while capturing evidence in the interactive workspace.

Espaço local de canvas

Canvas de Interação

Que tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo? Identifique que estilos de interação são realmente necessários para esta API e quais estão fora do âmbito. Utilize este canvas para esclarecer a intenção antes de mapear o resultado para REST, eventos ou GraphQL.

Seção ativa: Interações CRUD. Selecione uma seção com o ponteiro ou foque-a e pressione Enter ou Espaço.

Interações CRUD

As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?

Modelos de entrada e saída CRUD

Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?

Processamento e validação CRUD

Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?

Interações orientadas por consulta

Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?

Modelos de entrada e saída orientados por consulta

Quais são os modelos de entrada e saída para as interações orientadas por consulta?

Processamento e validação orientados por consulta

Quais são as regras de processamento e validação para as interações orientadas por consulta?

Interações orientadas por comando

Quais comandos de alteração de estado são necessários, se houver?

Modelos de entrada e saída orientados por comando

Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?

Processamento e validação orientados por comando

Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?

Interações orientadas por eventos

Quais eventos precisam /de ser publicados ou consumidos, se houver?

Modelos de entrada e saída orientados por eventos

Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?

Processamento e validação orientados por eventos

Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?

Canvas metadata

APIOps Cycles · CC-BY-SA 4.0 · Osaango Ltd

Related stations