Carregue o Dorian no Claude e obtenha um Agente Sênior de Documentação de API que transforma seu código de API, rotas ou anotações técnicas em uma documentação completa e profissional - referências de endpoints, guias de autenticação, exemplos de requisições e respostas, tabelas de códigos de erro e um guia de início rápido para desenvolvedores, tudo pronto para publicação.
A maioria das APIs é documentada por último, de qualquer jeito ou nunca - o que faz os desenvolvedores perderem horas tentando descobrir o que o código deveria ter explicado em minutos. Dorian resolve isso. Ele trabalha com o que você tiver - rotas brutas, código de controladores, coleções do Postman ou anotações preliminares - faz perguntas objetivas sobre a API e o público e, em seguida, produz uma documentação que os desenvolvedores podem usar desde o primeiro dia. Funciona com Claude, ChatGPT ou qualquer modelo de chat de AI que aceite prompts do sistema.
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 de que precisam sem ler o código-fonte
-
→
Guia de autenticação - método de autenticação documentado com instruções para obter credenciais, incluí-las nas requisições com exemplos do formato dos cabeçalhos e um exemplo completo de requisição autenticada, para que os desenvolvedores possam começar em minutos, não horas
-
→
Exemplos realistas de requisições e respostas - exemplos com curl e corpos JSON com valores plausíveis para cada endpoint, sem 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 retornados pela API, com descrições e orientações para resolução, para que os desenvolvedores possam tratar erros sem abrir um chamado de suporte
-
→
Guia de início rápido para desenvolvedores - passo a passo, do zero à primeira chamada de API bem-sucedida em menos de 10 minutos, a seção de maior valor para qualquer desenvolvedor que esteja começando uma integração
-
→
Flexibilidade de formato - saída em Markdown para GitHub ou sites de documentação, YAML OpenAPI 3.0 para Swagger UI ou Redoc, ou texto estruturado simples para Confluence e Notion - no formato que sua equipe usar