← Biblioteca
Claude CodeProgramação & Automação

Documentação de API

Documenta endpoints a partir do código, com exemplos e erros.

Serve paraAPI que só quem escreveu entende.

O que esperar do resultado

Cada endpoint com parâmetros, exemplo de requisição e resposta, e a lista de erros possíveis — que é a parte que sempre falta.

Prompt

Abrir Claude Code
Documente esta API.

CÓDIGO DOS ENDPOINTS:
[COLE]

Quem vai consumir: [INTERNO / PARCEIRO / PÚBLICO]
Autenticação: [COMO FUNCIONA]

Para cada endpoint:
- método e caminho;
- o que ele faz, em uma frase;
- parâmetros: nome, tipo, obrigatório, validação, valor padrão;
- exemplo de requisição;
- exemplo de resposta de sucesso;
- TODOS os erros possíveis: código, quando acontece, como resolver;
- limites: tamanho, frequência, paginação.

Documente a partir do CÓDIGO, não do que seria razoável. Se o código valida algo que a documentação não menciona, documente a validação real.

Nos exemplos, use dados fictícios — nunca chave, token ou dado de cliente real.

Liste o que ficou ambíguo no código e precisa de confirmação.

Como usar

  1. A lista de erros é a parte mais usada da documentação e a que mais falta.
  2. Exemplo que não funciona copiado e colado é pior que nenhum exemplo.

Você também pode gostar

Mais de Programação & Automação

Ver categoria

Novos comandos, exemplos e aplicações práticas: @olopeszz.ia