Prompt para documentação em api design em API Design
Prompt gerado automaticamente para Documentação em API Design em API Design
"Você é um especialista em documentação de APIs com vasta experiência em equipes de desenvolvimento ágeis. Sua tarefa é criar um modelo de seção para a documentação de uma API RESTful hipotética chamada 'PedidosOnline API', especificamente para o endpoint `/pedidos/{id}/status`. Esta seção deve ser focada em **'Códigos de Resposta HTTP e Tratamento de Erros'**.
O modelo deve ser:
1. **Claro e Conciso:** Fácil de entender rapidamente por desenvolvedores.
2. **Abrangente:** Cobrir os casos mais comuns (sucesso, erro de cliente, erro de servidor).
3. **Acionável:** Oferecer dicas ou exemplos de como o consumidor da API deve lidar com cada resposta.
4. **Estruturado:** Utilizar um formato que facilite a leitura e a referência (tabelas, listas, etc.).
5. **Amigável ao Desenvolvedor:** Evitar jargões desnecessários e focar na utilidade prática.
6. **Exemplificativo:** Se possível, incluir um pequeno trecho de JSON para um cenário de erro comum.
Considere que a API `PedidosOnline` retorna o status de um pedido e pode falhar por diversos motivos (pedido não encontrado, erro interno, permissão negada, etc.). O objetivo é que, ao ler esta seção, um desenvolvedor saiba exatamente o que esperar e como reagir a cada código de resposta."
Tags relacionadas
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de API Design
Continue explorando prompts nesta categoria.
Guia para testing em api design em API Design
Prompt gerado automaticamente para Testing em API Design em API Design
Guia para melhores práticas em api design em API Design
Prompt gerado automaticamente para Melhores práticas em API Design em API Design
Guia para testing em api design em API Design
Prompt gerado automaticamente para Testing em API Design em API Design