Preparar casos de teste com uma operação OpenAPI

Escolha a operação e o formato de saída. Adicione autenticação, dados de teste e asserções de contrato; os testes gerados não são executados nesta página.

Funciona localmente no seu navegador
Esta ferramenta processa todos os dados localmente no seu navegador.
Definição OpenAPICole um documento OpenAPI 3.x ou Swagger 2.0 em JSON/YAML. Ele é analisado localmente; nenhum servidor ou endpoint é contatado.
Casos de teste gerados

Como preparar casos de teste a partir de uma operação OpenAPI

Cole um documento OpenAPI 3.x ou Swagger 2.0, ou abra um arquivo local .json, .yaml ou .yml. Os caminhos, parâmetros, corpos de requisição e respostas são lidos no navegador, e as operações encontradas são listadas para você escolher.

Escolha uma operação e depois Plano de teste JSON para ver os casos que vale cobrir ou Vitest + fetch para obter uma base executável que monta a requisição. Nada é enviado e nenhum endpoint é chamado.

  1. Cole a definição ou carregue um arquivo e clique em Analisar API. Cada operação em paths aparece com método, caminho e resumo.
  2. Selecione a operação, escolha Plano de teste JSON ou Vitest + fetch e clique em Gerar testes. O resultado aparece na caixa de baixo.
  3. Use Copiar ou Baixar para levar o resultado; Limpar esvazia a entrada, a lista de operações e a saída.
  4. Antes de executar qualquer coisa, acrescente o que só você sabe: autenticação, dados de teste reais, a URL base se o documento não tiver servidor e as asserções que o seu contrato exige.

O que o plano e a base cobrem, e o que fica com você

O que a leitura do documento cobre

Referências locais são resolvidas até a definição: parâmetros declarados em um caminho, corpos de requisição e esquemas de components. Parâmetros de caminho são sempre tratados como obrigatórios, como exige a especificação, mesmo quando o documento esquece a marcação.

Documentos Swagger 2.0 também são lidos. A URL base é montada com schemes, host e basePath, e um parâmetro body vira o corpo JSON. No OpenAPI 3 usa-se a primeira URL de servers, substituindo variáveis de servidor pelos valores padrão.

O que o código gerado contém

O arquivo Vitest importa describe, expect e it; declara cada parâmetro de caminho como uma constante em camelCase; monta a URL com encodeURIComponent; define os parâmetros de consulta com URLSearchParams; e envia o corpo JSON com o cabeçalho Content-Type correspondente. A única asserção é que o status seja 2xx.

O plano JSON traz um caminho feliz, um caso de entrada ausente para cada parâmetro obrigatório (parâmetros de caminho e corpo incluídos) e um caso para cada resposta 4xx ou 5xx documentada. Os dois formatos leem o documento do mesmo jeito, então os nomes dos casos batem com a base.

Onde a ferramenta para

Tudo roda na página e os testes gerados não são executados aqui. Um status 2xx não prova que o corpo da resposta segue o esquema, então trate a saída como um rascunho a ampliar.

Documentos muito grandes também são analisados no navegador; se algum ficar lento, reduza-o aos caminhos que você está testando. Para conferir antes a própria definição, o validador OpenAPI da mesma categoria aponta problemas de estrutura e de referência.

Ferramentas recentes: