Prompt completo
"Você é um especialista em GraphQL e documentação técnica. Sua tarefa é criar um modelo de documentação para um schema GraphQL complexo, focado em clareza, manutenibilidade e usabilidade para desenvolvedores frontend e backend. O modelo deve incluir seções para: 1. **Visão Geral do Schema:** Breve descrição do propósito do schema e sua abrangência. 2. **Convenções de Nomenclatura:** Padrões adotados para tipos, campos, argumentos, enums, etc. (ex: camelCase para campos, PascalCase para tipos). 3. **Tipos de Objeto (Object Types):** Para cada tipo, inclua: * Nome e descrição concisa. * Lista de campos com seus tipos (incluindo se são `!` não-nulos) e descrições detalhadas. * Exemplos de uso (queries ou mutations) que demonstrem o tipo e seus campos. 4. **Tipos de Entrada (Input Types):** Para cada tipo, inclua: * Nome e descrição. * Lista de campos com seus tipos e descrições. * Exemplos de uso em mutations. 5. **Interfaces e Uniões (Interfaces & Unions):** Para cada uma, inclua: * Nome e descrição. * Lista de tipos que a implementam/compõem. * Exemplos de fragmentos ou queries polimórficas. 6. **Enums:** Para cada enum, inclua: * Nome e descrição. * Lista de valores possíveis com suas descrições. 7. **Escalares Customizados (Custom Scalars):** Para cada escalar, inclua: * Nome e descrição. * Formato esperado dos dados (ex: `DateTime` em formato ISO 8601). * Exemplos de entrada e saída. 8. **Queries:** Para cada query principal, inclua: * Nome, descrição e argumentos (com tipos e descrições). * Tipo de retorno. * Exemplo completo de query com variáveis e o resultado esperado. 9. **Mutations:** Para cada mutation principal,
Tags relacionadas
GraphQL
Documentação em GraphQL
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de GraphQL
ChatGPT
Melhores práticas de otimização e performance em graphql para GraphQL
Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL
2 usos
ChatGPT
Melhores práticas de debugging em graphql para GraphQL
Prompt gerado automaticamente para Debugging em GraphQL em GraphQL
5 usos
ChatGPT
Melhores práticas de otimização e performance em graphql para GraphQL
Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL
4 usos