Design de API REST com versionamento e documentação OpenAPI
Projeta uma API REST robusta com padrões de naming, versionamento, paginação e documentação Swagger.
Objetivo do Prompt
Criar uma API REST profissional e bem documentada que siga as melhores práticas da indústria e facilite a integração por times frontend e parceiros externos.
Exemplo Real de Uso
A logtech catarinense EnviaJá está construindo uma API pública para que marketplaces integrem seu serviço de frete. Precisam de uma API que suporte 500 req/s, seja fácil de integrar e tenha documentação clara para os 30 parceiros que vão consumir.
Prompt
Projete uma API REST completa para [NOME DO PROJETO], um [TIPO: SaaS/marketplace/fintech] construído com [NODE.JS + EXPRESS/FASTIFY/NESTJS] e [POSTGRESQL/MYSQL].
**Contexto:**
- Recursos principais: [LISTA DE ENTIDADES: usuários, pedidos, produtos, etc.]
- Consumidores: [FRONTEND SPA, APP MOBILE, PARCEIROS EXTERNOS]
- Volume esperado: [NÚMERO] requisições/segundo
- Autenticação: [JWT/API KEY/OAUTH2]
**1) Convenções e Naming:**
- Estrutura de URLs (plural, kebab-case, hierarquia)
- Métodos HTTP por operação (GET, POST, PUT, PATCH, DELETE)
- Status codes padronizados (sucesso, erro cliente, erro servidor)
- Formato de resposta padrão: `{ data, meta, errors }`
- Envelope de erro: `{ code, message, details, timestamp }`
**2) Versionamento:**
- Estratégia: URL path (/v1/) vs. header vs. query param — recomende e justifique
- Política de depreciação (timeline, headers de aviso)
- Manutenção de compatibilidade retroativa
**3) Paginação, Filtro e Ordenação:**
- Cursor-based pagination (para feeds) vs. offset (para tabelas)
- Filtros via query params: `?status=ativo&created_after=2026-01-01`
- Ordenação: `?sort=-created_at,name`
- Campos parciais: `?fields=id,name,email`
- Resposta meta: `{ total, page, per_page, next_cursor }`
**4) Autenticação e Autorização:**
- Fluxo de autenticação JWT (access + refresh tokens)
- Middleware de autorização por role (admin, user, partner)
- Rate limiting por API key (tiers: free, pro, enterprise)
- CORS configuração por ambiente
**5) Documentação OpenAPI 3.1:**
- Schema de cada endpoint com exemplos
- Modelos de request/response tipados
- Autenticação documentada (securitySchemes)
- Geração automática com Swagger UI
- Postman collection exportada
Inclua exemplos completos para os endpoints de [RECURSO PRINCIPAL] (CRUD + busca + ações customizadas).Como usar este prompt
- 1Cole o prompt diretamente no ChatGPT, Claude, Gemini ou qualquer assistente de IA.
- 2Personalize os campos entre colchetes [assim] com suas informações específicas.
- 3Para melhores resultados, forneça contexto adicional sobre seu caso de uso.
- 4Combine múltiplos prompts em uma conversa para resultados mais completos.
- 5Salve os prompts que mais usa para acesso rápido no futuro.
Prompts relacionados
Ver todosOtimização de queries PostgreSQL e estratégia de indexação
Diagnóstico de performance do banco de dados com análise de queries lentas e plano de indexação.
Sistema de autenticação completo com JWT, refresh tokens e RBAC
Implementação segura de autenticação e autorização com tokens rotativos e controle de acesso baseado em roles.
Migração de monolito para microsserviços com event-driven architecture
Estratégia de decomposição de um monolito Node.js em microsserviços com comunicação assíncrona.
Estratégia de caching multi-camada com Redis e CDN
Implementação de cache em múltiplas camadas para reduzir latência e custos de infraestrutura.
Explore outras categorias de prompts
Assine o AulasDeIA para desbloquear
Acesse 10.000+ prompts prontos para usar em qualquer profissão, além de todos os cursos da plataforma.
Cancele quando quiser. Sem multas.
