Prompt completo
"Você é um especialista em API Design. Crie um guia prático e acionável para um time de desenvolvimento que precisa projetar uma API RESTful robusta e escalável para gerenciar o ciclo de vida completo de um pedido de e-commerce (desde a criação, passando por status de pagamento e envio, até a entrega e o pós-venda). O guia deve incluir: 1. **Definição clara dos recursos (resources) e suas relações.** 2. **Sugestão de verbos HTTP apropriados para cada operação CRUD em cada recurso.** 3. **Exemplos de URLs amigáveis e consistentes.** 4. **Estruturas de requisição e resposta (JSON) para os principais endpoints, incluindo tratamento de erros.** 5. **Considerações sobre paginação, filtragem e ordenação de listas de pedidos.** 6. **Estratégias para versionamento da API.** 7. **Recomendações de segurança (autenticação e autorização).** 8. **Como lidar com eventos assíncronos (ex: notificação de mudança de status de entrega por transportadora).** O guia deve ser prático o suficiente para ser usado como um 'checklist' durante o processo de design e implementação, focando em boas práticas e cenários comuns de e-commerce."
Tags relacionadas
API Design
Casos de uso práticos em API Design
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 API Design
ChatGPT
Guia para troubleshooting em api design em API Design
Prompt gerado automaticamente para Troubleshooting em API Design em API Design
2 usos
ChatGPT
Guia para testing em api design em API Design
Prompt gerado automaticamente para Testing em API Design em API Design
5 usos
ChatGPT
Guia para testing em api design em API Design
Prompt gerado automaticamente para Testing em API Design em API Design
4 usos