Explorar definições de API e gerar código de requisição

Cole a definição, selecione um endpoint e informe parâmetros de exemplo. Revise o código antes de executá-lo no seu próprio cliente de API.

Funciona localmente no seu navegador
Definição de API

Cole um documento OpenAPI 3.x ou Swagger 2.0 em JSON ou YAML. Esta ferramenta não envia nem busca nada.

Operações disponíveis
Analise uma definição para navegar pelos endpoints.
Construtor de requisições

Escolha um endpoint acima para criar seus campos de caminho, consulta, cabeçalho e corpo.

Select an endpoint to generate a cURL command.
Select an endpoint to generate Fetch code.

Explore uma especificação de API sem enviá-la a lugar nenhum

O OpenAPI Explorer lê JSON ou YAML local, apresenta endpoints e campos obrigatórios e cria trechos de requisição que você pode ajustar antes de usar no seu cliente de API. Ele não envia requisições, tokens ou especificações a outro serviço.

Como montar uma requisição a partir de uma definição

Cole uma definição OpenAPI 3.x ou Swagger 2.0 para listar todas as operações declaradas, preencher os parâmetros documentados e copiar um trecho cURL ou Fetch do endpoint escolhido.

A definição, a URL do servidor e o token Bearer ficam no navegador. O documento é analisado localmente e esta página não envia nenhuma requisição para a sua API.

  1. Cole a definição no editor em JSON ou YAML, ou clique em Load example para partir de um exemplo.
  2. Clique em Analyze definition. A lista de operações mostra cada método e caminho; se o documento não tiver marcador de versão ou não tiver operações em paths, a linha de status informa isso.
  3. Escolha uma operação para montar o formulário de parâmetros a partir da definição: campos de caminho, query e cabeçalho, além de corpo da requisição quando a definição descreve um.
  4. Preencha os campos obrigatórios. Todos os parâmetros documentados precisam estar presentes antes de gerar o código, e a linha de status indica o primeiro que ainda falta.
  5. Clique em Generate request code e depois em Copy cURL ou Copy Fetch. Defina antes a URL do servidor ou um token Bearer se o endpoint precisar.

O que o gerador faz e o que não faz

Quais definições são aceitas

OpenAPI 3.x e Swagger 2.0 são lidos, em JSON ou YAML, e o marcador de versão define como servidores, parâmetros e corpos de requisição são interpretados. Um documento sem nenhum dos marcadores é recusado com uma mensagem que indica o campo raiz ausente.

As linhas de operação vêm do objeto paths: uma linha por método, identificada pelo caminho e pelo resumo da operação, ou por "No summary provided" quando a definição não traz resumo.

Os trechos gerados são um ponto de partida

O VoriTools escreve a requisição a partir da definição e nunca a executa. Esta página não envia nada para a sua API, então um token digitado serve apenas para preencher o texto do trecho.

O trecho leva os parâmetros e cabeçalhos que a definição documenta. Tudo o que ela não descrever — tentativas, assinatura, paginação, fluxos OAuth — precisa ser acrescentado no seu próprio cliente.

Perguntas frequentes

Esta ferramenta chama a minha API?

Não. Ela lê a definição e escreve o código da requisição; a requisição nunca é executada aqui, então nenhum tráfego chega à sua API a partir desta página.

Quais formatos de definição são aceitos?

OpenAPI 3.x e Swagger 2.0, escritos em JSON ou YAML. O marcador de versão na raiz do documento define como cada campo é interpretado.

Ferramentas recentes: