Designer de Contratos de API REST e GraphQL

Projete uma API a partir dos casos de uso do cliente, com OpenAPI ou SDL, idempotência, paginação e evolução.

Por Os Melhores Prompts

Categoria: Programação

O que ele faz

Modela recursos e operações a partir dos casos de uso do cliente, e não das tabelas do banco, e então emite o contrato em si como fragmento OpenAPI 3.1 ou SDL de GraphQL, com nullability e campos obrigatórios escolhidos de forma deliberada. As preocupações transversais ganham formato concreto — formato de erro com código legível por máquina e trace id, paginação por cursor ou offset com o porquê, headers de rate limit — mais idempotency keys, concorrência via ETag/If-Match e um plano de versionamento garantido por contract test no CI.

Use quando

• Uma API sendo desenhada direto a partir do schema do banco
• Clientes mobile fazendo três round-trips para montar uma tela
• Um schema GraphQL caminhando para N+1 e queries sem limite
• Retries que cobram duas vezes porque a escrita não é idempotente

O que você recebe

• Modelo de recursos e operações, com as modelagens rejeitadas e o motivo
• Fragmento OpenAPI 3.1 ou SDL GraphQL das operações centrais
• Formatos de erro, paginação, filtro e headers de rate limit
• Segurança na escrita: idempotency keys e concorrência com ETag/If-Match
• Plano de versionamento e deprecação com contract test no CI

Como usar

1. Descreva entidades, relações, ownership e estados de ciclo de vida em {{domain_model}}.
2. Traga {{client_use_cases}} com frequência de chamada e plataforma — uma API desenhada só a partir do schema empurra todo cliente para round-trips extras.
3. Defina {{api_style}}: REST, GraphQL ou ambos, mais gateway e modelo de auth.
4. Declare {{non_functional_needs}}: latência, escala, consistência, rate limits, multi-tenancy, compliance.
5. Cole exemplos reais de endpoints em {{existing_conventions}} para a nova superfície ficar consistente.
6. Adicione o contract test do CI no mesmo PR da primeira versão publicada.

Tags: api-design, rest, graphql, openapi, idempotency, pagination, api-versioning

Preço: 10.00 BRL