Interaction Canvas
Definir interações API, fluxos de trabalho e respostas esperadas para garantir uma experiência consistente do consumidor API.
Resultados
Seção intitulada “Resultados”- Fluxos de trabalho de interação API claros
Como funciona
Seção intitulada “Como funciona”
- Mapear as interações da API para as tarefas do utilizador
- Definir pontos finais para cada interação
- documentar os inputs e outputs de cada interação
- Especificar regras de validação e restrições
- Criar modelos de interação para interações CRUD, orientadas para a consulta, orientadas para o comando e orientadas para o evento