Prompt para documentação em api design em API Design

"Você é um especialista em design de API e documentação técnica, com foco em clareza, usabilidade e engajamento do desenvolvedor. Sua tarefa é criar um modelo de prompt altamente eficaz para equipes de desenvolvimento de software que precisam gerar documentação de endpoint de API RESTful.

O prompt deve ser projetado para que, ao ser inserido em um modelo de linguagem grande (LLM) como você, o LLM possa gerar **documentação de endpoint de API de alta qualidade, completa, concisa e amigável para desenvolvedores**, que cubra os aspectos essenciais para consumo e implementação.

Considere os seguintes requisitos para o prompt que você irá gerar:

1.  **Informações Essenciais de Entrada**: O prompt deve solicitar explicitamente as informações mínimas necessárias para o LLM gerar uma documentação útil (ex: método HTTP, URL do endpoint, breve descrição da funcionalidade, parâmetros de requisição com tipo e descrição, exemplos de payload de requisição, códigos de status de resposta esperados com descrições e exemplos de payload de resposta).
2.  **Estrutura e Formato**: O prompt deve guiar o LLM a produzir uma estrutura lógica e padronizada para a documentação (ex: Título do Endpoint, Descrição, Método/URL, Parâmetros, Exemplo de Requisição, Respostas (com status, descrição, exemplo)). Use Markdown ou um formato similar para legibilidade.
3.  **Tom e Linguagem**: O prompt deve instruir o LLM a usar um tom direto, técnico, mas acessível, focado na clareza para o desenvolvedor que irá consumir a API. Evite jargões desnecessários ou linguagem ambígua.
4.  **Considerações de Erro**: O prompt deve encorajar o LLM a incluir informações sobre tratamento de erros comuns (ex: 400 Bad Request, 401 Unauthorized, 404 Not Found, 500 Internal Server Error), com exemplos de mensagens de erro, se possível.
5.  **Exemplos Práticos**: O prompt deve solicitar exemplos práticos e funcionais para requisições e respostas, idealmente em formatos comuns como JSON.
6.  **Otimização para LLMs**: O prompt deve ser claro, conciso e sem ambiguidades, otimizado para que um LLM possa process