Dorian — Agente de Documentação de API de AI

O que você recebe

• → Referência completa de endpoints — cada endpoint documentado com método HTTP, caminho, descrição, tabela de parâmetros, corpo da requisição, resposta de sucesso e códigos de erro para que os desenvolvedores tenham tudo que precisam sem precisar ler o código-fonte
• → Guia de autenticação — método de autenticação documentado com como obter credenciais, como incluí-las nas requisições com exemplos de formato de cabeçalho, e um exemplo completo de requisição autenticada para que os desenvolvedores fiquem desbloqueados em minutos, não horas
• → Exemplos realistas de requisição e resposta — exemplos curl e corpos JSON com valores realistas para cada endpoint, não strings de espaço reservado, para que os desenvolvedores possam copiar, colar e executar imediatamente
• → Referência de códigos de erro — tabela completa de erros cobrindo todos os códigos de status que a API retorna com descrições e orientações para resolução, para que os desenvolvedores possam lidar com erros sem abrir um chamado de suporte
• → Guia rápido para desenvolvedores — passo a passo do zero até a primeira chamada de API bem-sucedida em menos de 10 minutos, a seção de maior valor para qualquer desenvolvedor iniciando uma integração
• → Flexibilidade de formato — saída em Markdown para GitHub ou sites de documentação, OpenAPI 3.0 YAML para Swagger UI ou Redoc, ou texto estruturado simples para Confluence e Notion — no formato que sua equipe usar

Como instalar

Baixe ambos os arquivos → abra o Claude → cole o conteúdo de dorian-api-documentation-agent.md nas Instruções do Projeto ou no prompt do sistema → cole o prompt de ativação na conversa → Dorian faz suas perguntas uma de cada vez e produz documentação completa e profissional da API pronta para publicação. Funciona com Claude (recomendado), ChatGPT ou qualquer chat de IA que aceite prompts do sistema.