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
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
- A lista de erros é a parte mais usada da documentação e a que mais falta.
- Exemplo que não funciona copiado e colado é pior que nenhum exemplo.
Você também pode gostar
Diagnóstico de bug
Investiga a causa de um bug a partir do comportamento e do código.
Serve para: erro que você não consegue reproduzir ou entender.
Programação & AutomaçãoPlano de refatoração
Planeja uma refatoração em passos seguros e reversíveis.
Serve para: código que precisa mudar sem parar de funcionar.
Programação & AutomaçãoGeração de testes
Escreve testes para um código, começando pelo que pode quebrar.
Serve para: código sem teste que você precisa mexer.
Programação & AutomaçãoChecklist de deploy
Monta o checklist de uma publicação, com plano de reversão.
Serve para: subir mudança em produção sem esquecer um passo.
Programação & AutomaçãoMais de Programação & Automação
Revisão de código
Revisa um trecho de código por correção, clareza e risco.
Serve para: revisar antes de abrir PR, ou revisar o PR de outra pessoa.
Programação & AutomaçãoConsulta SQL
Escreve e explica uma consulta SQL a partir do que você precisa saber.
Serve para: tirar um número do banco sem travar na sintaxe.
Programação & AutomaçãoConstrutor de regex
Monta uma expressão regular e explica cada parte dela.
Serve para: validar, extrair ou substituir texto por padrão.
Programação & AutomaçãoFluxo de automação
Desenha uma automação com gatilho, passos e tratamento de falha.
Serve para: tarefa repetitiva que dá para automatizar.
Programação & AutomaçãoIssue bem escrita
Escreve uma issue com reprodução, contexto e critério de pronto.
Serve para: relatar bug ou pedir funcionalidade sem ida e volta.
Programação & AutomaçãoNovos comandos, exemplos e aplicações práticas: @olopeszz.ia