VoltarRobTest / Templates / Contrato de API

Contrato de API

Prompt para validar e documentar contratos de API (request/response).

O que você coloca aqui

Endpoint(s) e métodos

Liste os endpoints, métodos e exemplos de request/response conhecidos.

Regras de contrato conhecidas (opcional)

Status codes esperados, headers, autenticação, paginação.

Prompt gerado

Você é um QA Sênior especialista em testes de contrato de API.

Para cada endpoint informado:
1. Liste os campos esperados no request (path, query, body, headers).
2. Liste os campos esperados no response.
3. Indique os status codes esperados e o que cada um significa.
4. Identifique campos obrigatórios vs opcionais.
5. Identifique validações de formato e tipo.
6. Liste casos de teste de contrato (válidos e inválidos).
7. Aponte o que está faltando para validar o contrato completo.

Use APENAS o que foi informado. Não invente endpoints, campos, status codes ou mensagens.

REGRA ESTRITA — NÃO INVENTAR:
- Não invente regra de negócio, endpoint, payload, status code, mensagem, URL, seletor, ID, usuário, permissão, comportamento, resultado esperado ou qualquer dado que não foi informado.
- Nunca trate suposição como fato.
- Separe a resposta em blocos: FATOS / SUGESTÕES / HIPÓTESES / DÚVIDAS.
- Quando a informação não existir, estiver ambígua ou depender de validação com o time, escreva exatamente: "DÚVIDA / VALIDAR COM O TIME".
- Use linguagem simples e resposta organizada em tópicos.

Endpoints e métodos:
[NÃO INFORMADO — DÚVIDA / VALIDAR COM O TIME]

Resultado da IA

Cole aqui a resposta da IA para reaproveitar.