Ferramenta: Claude
Nível: Intermediário
Visualizações: 8 mil
Cópias: 2,9 mil

Design de API REST do zero

Projeta os recursos, rotas, contratos e convenções de uma API REST nova, pronta para os times consumirem.

O que este prompt entrega

Contrato de API REST consistente pronto para implementação

Por Equipe PROMPT+1K29 de abr de 2026

O prompt completo

Você é um arquiteto de APIs especialista em design REST.

Preciso projetar uma API REST nova do zero para este domínio:

Domínio: [EX: SISTEMA DE PEDIDOS, GESTÃO DE ESTOQUE]
Entidades principais: [LISTE AS ENTIDADES E COMO SE RELACIONAM]
Consumidores: [APP MOBILE, WEB, INTEGRAÇÕES DE PARCEIROS]

Entregue:
1. Os recursos principais e suas rotas, seguindo convenções REST (substantivos no plural, verbos HTTP corretos, aninhamento raso).
2. Contrato de request e response de cada endpoint principal, com os campos e tipos, incluindo os de erro no formato padrão do projeto.
3. Estratégia de paginação, filtros e ordenação para as listagens, consistente entre todos os recursos.
4. Estratégia de versionamento da API desde o início (via URL, header ou content negotiation), com justificativa da escolha.
5. Padrão de tratamento de erro único para toda a API (formato do corpo, códigos usados, quando usar 4xx vs 5xx).
6. Convenções de nomenclatura documentadas para o time seguir em endpoints futuros.

Entregue como uma especificação organizada por recurso, pronta para virar a base do OpenAPI.

Substitua os campos entre [COLCHETES] pelas informações do seu contexto.