Pular para o conteúdo
ChatGPTClaude Intermediário

Documentação técnica de API

Gere documentação clara de endpoints com exemplos de requisição, resposta e erros.

Comentar 3
Prompt
Crie a documentação técnica dos endpoints abaixo no formato Markdown.

Código/rotas:
```
[CÓDIGO OU LISTA DE ROTAS]
```

Para cada endpoint documente: método e caminho, descrição, autenticação, parâmetros (path, query, body) em tabela, exemplo de requisição com curl, exemplo de resposta de sucesso, códigos de erro possíveis e observações de limite de uso.
Inclua no início uma seção de "Primeiros passos".

407 caracteres · 268 cópias

Comentários (3)

Entre para comentar e tirar dúvidas com o criador.

  • GS

    Gabriel Souza

    Bem pensado o aviso no final, muita gente esquece desse cuidado.

    • RO

      Rafael OliveiraAUTOR

      Comigo funcionou melhor no Claude, mas os dois dão conta.

  • CR

    Camila Rocha

    Usei para um cliente hoje e ele adorou o resultado. Obrigado por compartilhar!

Você também pode gostar