Como melhorar documentação em graphql em GraphQL

Prompt gerado automaticamente para Documentação em GraphQL em GraphQL

5.0
34 usos
ChatGPT
Usar no ChatGPT
"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,

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de GraphQL

Continue explorando prompts nesta categoria.

Melhores práticas de otimização e performance em graphql para GraphQL

Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL

Melhores práticas de debugging em graphql para GraphQL

Prompt gerado automaticamente para Debugging em GraphQL em GraphQL

Melhores práticas de otimização e performance em graphql para GraphQL

Prompt gerado automaticamente para Otimização e performance em GraphQL em GraphQL