Forge de Documentação de Referência de API

Este modelo de gerador de documentação de API transforma definições de endpoints, arquivos de schema e anotações de implementação em uma documentação de referência bem acabada. Ele foi criado para produzir descrições consistentes de endpoints, campos de requisição e resposta, notas de autenticação e exemplos de payload. A estrutura ajuda as equipes a documentarem APIs com mais rapidez, mantendo o conteúdo alinhado com o contrato real — e não com texto genérico.

É ideal para engenheiros de plataforma, equipes de backend e redatores de developer experience que mantêm APIs públicas ou internas. O prompt incentiva o modelo a listar parâmetros obrigatórios, parâmetros opcionais, códigos de status e erros comuns em um formato que os desenvolvedores conseguem analisar rapidamente. Ele também oferece suporte a APIs versionadas, o que é útil quando você precisa de documentação separada para v1 e v2 ou quando desativações precisam ser destacadas com clareza. Use-o sempre que um schema mudar e a documentação precisar acompanhar sem reescrita manual.

Personalize o modelo fornecendo {{API_SPEC}}, {{AUTH_METHOD}} e {{TARGET_READERS}}. Adicione {{EXAMPLE_REQUESTS}}, {{ERROR_CODES}} e {{VERSION}} para gerar páginas de referência ainda mais completas. O resultado deve ser um guia de API estruturado, com tabelas de endpoints, exemplos de requisição, exemplos de resposta e notas sobre limites de taxa ou casos de borda. Para melhores resultados, inclua a URL base exata e quaisquer convenções de nomenclatura para que o modelo espelhe a estrutura real da sua API e a terminologia usada por você.