Laboratório de serialização de parâmetros OpenAPI

Visualize como os parâmetros de caminho, consulta, cabeçalho e cookie do OpenAPI são serializados de acordo com o estilo e explodem as configurações, localmente.

Cole ou escolha um documento OpenAPI 3.0, 3.1 ou 3.2, inspecione-o, selecione uma operação de caminho e ajuste cada valor de parâmetro JSON. Visualize o caminho, a string de consulta, os cabeçalhos e os cookies e copie as partes necessárias.

Carregue um documento OpenAPI, escolha uma operação e visualize como seus parâmetros se tornam um alvo de solicitação, cabeçalhos e cookies. Nenhuma solicitação é enviada.

Cole JSON ou YAML abaixo ou escolha um arquivo.

Até 2 MB e 300 operações de caminho. Suporta OpenAPI 3.0, 3.1 e 3.2. Referências externas não são buscadas.

Como usar

Verifique como um parâmetro de API aparece na transmissão

Visualize como os parâmetros de caminho, consulta, cabeçalho e cookie do OpenAPI são serializados de acordo com o estilo e explodem as configurações, localmente.

Passo a passo

  1. Forneça a origem usando: Especificação OpenAPI.
  2. Execute: Inspecionar especificação. Confira o resultado antes de copiar, baixar ou usar em outro lugar.
  3. Ajuste: Operação de caminho. Use a referência abaixo para escolher as opções adequadas à tarefa.
  4. Execute: Visualização da serialização. Confira o resultado antes de copiar, baixar ou usar em outro lugar.
  5. Cole ou escolha um documento OpenAPI 3.0, 3.1 ou 3.2, inspecione-o, selecione uma operação de caminho e ajuste cada valor de parâmetro JSON. Visualize o caminho, a string de consulta, os cabeçalhos e os cookies e copie as partes necessárias.

Como escolher as configurações

OpçãoO que muda
Operação de caminhoEle aplica o estilo OpenAPI e configurações de explosão aos parâmetros de caminho, consulta, cabeçalho e cookie. Os estilos comuns suportados incluem simples, rótulo, matriz, formulário, spaceDelimited, pipeDelimited e deepObject.
Visualização da serializaçãoParâmetros baseados em conteúdo, matrizes ou objetos aninhados, combinações de estilos indefinidos e referências externas não são adivinhados. Os valores do cabeçalho são mostrados sem codificação URI porque as regras de cotação do cabeçalho dependem do cabeçalho. O esquema não é validado.

Exemplo e resultado esperado

Para GET /users/{id}, uma matriz de consulta `tag: [api, local]` com `style: form` e `explode: true` torna-se `tag=api&tag=local`. Um valor de caminho escalar é codificado antes de ser inserido no caminho. A ferramenta não valida o esquema nem envia uma solicitação; codificações de conteúdo não suportadas, valores aninhados e referências externas são deixadas para revisão manual.

Se não funcionar

  • Parâmetros baseados em conteúdo, matrizes ou objetos aninhados, combinações de estilos indefinidos e referências externas não são adivinhados. Os valores do cabeçalho são mostrados sem codificação URI porque as regras de cotação do cabeçalho dependem do cabeçalho. O esquema não é validado.
  • Não. A ferramenta cria apenas uma visualização local para a operação selecionada. Ele não resolve servidores, adiciona autenticação ou envia solicitações de rede.
  • Se a análise falhar, confira a sintaxe JSON ou YAML antes dos resultados da API. Inclua as referências locais necessárias no mesmo documento. Referências externas e estruturas não aceitas exigem revisão manual; a ferramenta não as busca nem testa um servidor real.

O que esta ferramenta serializa?

Ele aplica o estilo OpenAPI e configurações de explosão aos parâmetros de caminho, consulta, cabeçalho e cookie. Os estilos comuns suportados incluem simples, rótulo, matriz, formulário, spaceDelimited, pipeDelimited e deepObject.

O que precisa de revisão manual?

Parâmetros baseados em conteúdo, matrizes ou objetos aninhados, combinações de estilos indefinidos e referências externas não são adivinhados. Os valores do cabeçalho são mostrados sem codificação URI porque as regras de cotação do cabeçalho dependem do cabeçalho. O esquema não é validado.

Ele chama a API?

Não. A ferramenta cria apenas uma visualização local para a operação selecionada. Ele não resolve servidores, adiciona autenticação ou envia solicitações de rede.