Prompt completo
Imagine que você é um engenheiro de software sênior na equipe de Go de uma grande empresa de tecnologia. Você percebeu que a documentação interna para a criação e manutenção de APIs RESTful em Go, embora tecnicamente correta, é inconsistente em termos de estilo, profundidade e exemplos práticos entre diferentes módulos e times. Isso leva a retrabalho, confusão para desenvolvedores juniores e atrasos em novos projetos. Sua tarefa é criar um **guia de estilo e boas práticas abrangente e prático para a documentação de APIs RESTful em Go**, focado em **clareza, usabilidade e padronização**. Este guia deve ser consumível por desenvolvedores de todos os níveis de experiência na empresa. **Considerando o modelo de IA como seu assistente especializado**, gere o conteúdo principal deste guia, cobrindo os seguintes pontos essenciais: 1. **Estrutura de Documentação de Endpoints:** Proponha uma estrutura consistente para documentar cada endpoint (método HTTP, caminho, descrição, parâmetros de requisição, corpo da requisição, respostas esperadas – sucesso e erro). 2. **Uso de Comentários em Go (`//` e `/* */`):** Explique onde e como usar comentários de forma eficaz para documentar código e lógica de negócios, distinguindo entre comentários para o compilador/ferramentas e para o leitor humano. 3. **Geração de Documentação Automática (e.g., Swagger/OpenAPI):** Apresente as melhores práticas para anotar código Go (e.g., usando `swag` ou anotações para `go-swagger`) de forma que a documentação OpenAPI gerada seja rica, precisa e fácil de entender. Inclua exemplos de anotações comuns. 4. **Exemplos de Código (Code Snippets):** Dê diretrizes sobre a inclusão de exemplos de código relevantes (e.g., como fazer uma requisição CURL ou um snippet em Go para consumir a API) e onde eles devem ser colocados. 5. **Documentação de Erros e Códigos de Status HTTP:** Como documentar de forma clara os possíveis erros, seus códigos de status HTTP correspondentes e as mensagens de erro retornadas pela API. 6. **Convenções de Nomenclatura para Documentação:** Sugira convenções
Tags relacionadas
Go
Documentação em Go
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de Go
ChatGPT
Melhores práticas de documentação em go para Go
Prompt gerado automaticamente para Documentação em Go em Go
3 usos
ChatGPT
Melhores práticas de debugging em go para Go
Prompt gerado automaticamente para Debugging em Go em Go
4 usos
ChatGPT
Melhores práticas de casos de uso práticos em go para Go
Prompt gerado automaticamente para Casos de uso práticos em Go em Go
4 usos