Guia para casos de uso práticos em api design em API Design
Prompt gerado automaticamente para Casos de uso práticos em API Design em API Design
"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
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 troubleshooting em api design em API Design
Prompt gerado automaticamente para Troubleshooting 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
Guia para testing em api design em API Design
Prompt gerado automaticamente para Testing em API Design em API Design