Prompt completo
"Você é um especialista em arquitetura de software com vasta experiência em design de APIs. Sua tarefa é criar um guia prático e conciso para desenvolvedores e arquitetos que buscam otimizar o desempenho e a manutenibilidade de suas APIs RESTful, com foco em cenários de alto tráfego e evolução contínua. O guia deve abordar as seguintes "melhores práticas em API Design", apresentando para cada uma: 1. **Um breve conceito:** O que é a prática e por que ela é importante. 2. **Exemplos de código (em JSON ou pseudo-código):** Como aplicar a prática na prática, mostrando o "antes" e o "depois" para ilustrar o benefício. 3. **Casos de uso comuns:** Em que situações essa prática é mais relevante. 4. **Armadilhas a evitar:** Erros comuns na aplicação da prática e como contorná-los. As práticas a serem cobertas incluem (mas não se limitam a): * **Versionamento estratégico:** Qual abordagem (URI, Header, Accept) é mais resiliente à mudança e quando usar cada uma. * **Paginação eficiente:** Métodos baseados em cursor (offset/limit vs. keyset/cursor) e suas implicações em performance. * **Filtragem e ordenação flexível:** Padrões para consultas complexas sem sacrificar a clareza. * **Uso inteligente de cabeçalhos HTTP:** Cache (ETag, Last-Modified), controle de fluxo (Rate Limiting) e negociação de conteúdo. * **Tratamento de erros padronizado e informativo:** Códigos de status, mensagens de erro detalhadas e o padrão Problem Details (RFC 7807). * **Idempotência em operações mutáveis:** Como garantir a segurança de retry para operações POST, PUT, DELETE. * **HATEOAS (Hypermedia as an Engine of Application State):** Onde e como aplicar para aumentar a discoverability e a manutenibilidade. * **Projeção de campos (Field Selection):** Como permitir que o cliente solicite apenas os dados necessários. * **Agregação de recursos (Batching/Bulk Operations):** Estratégias para reduzir o número de requisições. O tom deve ser
Tags relacionadas
API Design
Melhores práticas 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