GraphQL Canvas

Conceber APIs GraphQL definindo tipos, consultas, mutações e subscrições.

Resultados

• Conceção da API GraphQL estruturada

Como funciona

SVG | PNG | JSON

Passos

1. Que problemas estão os consumidores de API a tentar resolver? De que dados necessitam?
2. Definir tipos GraphQL e seus atributos: Quais são os principais tipos expostos (por exemplo, utilizador, encomenda, produto)?
3. Mapear relações entre tipos: Como é que os tipos se relacionam uns com os outros em consultas aninhadas?
4. Especificar consultas para a recuperação de dados
5. Definir mutações para a modificação de dados: Que operações irão modificar os dados (por exemplo, criar, atualizar, eliminar)?
6. Assinaturas de esboços para actualizações em tempo real
7. Definir autenticação e autorização: Quem pode aceder a que campos ou tipos?
8. Considerar se existem restrições de paginação, filtragem ou limitação de taxa

Dica

• Utilizar a introspeção para validar definições de tipos
• documentar exemplos de consultas e mutações
• Assegurar que os nomes dos tipos são descritivos e coerentes