Ferramentas de API

Postman para OpenAPIconfira a migração

Carregue uma coleção, especificação ou ambiente e revise as requisições e o relatório antes de exportar.

Postman para OpenAPI

Coleção, especificação ou ambiente

Resultado

O texto fica neste navegador. Nenhuma requisição API, execução de script ou busca de referência externa.

Opções de saída

Converte exemplos, não um contrato completo. Revise o relatório e os marcadores restantes.

500.000 caracteres · profundidade 60 · 50.000 nós · 1.000 requisições · 500 avisos · 5 segundos.

Resultado desatualizado. Valide novamente antes de exportar.

Cópia e download incluem toda a visualização selecionada. O mascaramento altera apenas a saída.

Postman para OpenAPI ajuda quando uma coleção de chamadas que funcionam precisa virar documentação de API. Uma requisição descreve um exemplo; um contrato define o que pode ser enviado. Os dois arquivos têm objetivos diferentes e a migração exige conferir o que ficou de fora.

Na direção inversa, mantenha a especificação original junto da coleção criada. Marcadores de autenticação, definições de resposta e restrições do esquema não são todos reproduzidos pelas requisições geradas.

Por que revisar Postman para OpenAPI aqui?

Rastreie requisições e omissões

Postman para OpenAPI percorre pastas aninhadas e usa o caminho da pasta como tag da operação. A lista mostra as chamadas lidas; o relatório aponta scripts, variáveis e campos não mapeados. Requisições com o mesmo método e caminho interrompem a conversão para evitar sobrescrita.

Cartões de requisições saem de pastas e chegam a um documento de API, enquanto um script segue para um aviso.

Revise credenciais antes de compartilhar

A formatação e a exportação de ambiente ativam o mascaramento por padrão. Valores sensíveis reconhecidos são substituídos na saída. Linhas desativadas são relatadas separadamente, permitindo entender por que o arquivo .env contém menos entradas.

Linhas de variáveis seguem para um arquivo de configuração; um segredo é mascarado e uma linha desativada vai para o relatório.

Três escolhas antes de usar o arquivo

01

Escolha a origem correta

Trocar a direção não substitui o texto. Em seguida, carregue o exemplo do modo ou importe um arquivo compatível. A coleção precisa declarar o esquema 2.1; o ambiente precisa conter um array values.

02

Confira quando a saída fica atualizada

O modo automático aguarda 350 ms após a edição. Desative-o para fazer várias alterações e executar com Ctrl/Cmd + Enter. Alterar entrada ou opções bloqueia cópia e download até que o novo resultado esteja pronto.

03

Exporte a visualização revisada

Resultado exporta o documento convertido, Requisições a lista inteira e Relatório os códigos e caminhos de origem. A tela mostra 50 itens por vez, mas o download inclui todos os itens da visualização selecionada.

Coleção, contrato e configuração de ambiente

Conversão nos dois sentidos

Este conversor de coleções API gera OpenAPI 3.0.3 em JSON ou YAML. OpenAPI para Postman aceita 3.0 e 3.1 e produz uma coleção Postman 2.1. Referências locais necessárias aos detalhes das operações são resolvidas no próprio documento fornecido.

Exemplos sem inventar regras

Valores de query e cabeçalhos viram exemplos de strings. O corpo JSON continua sendo um exemplo, sem deduzir required ou enum a partir de um único caso. No sentido inverso, usa-se example ou default; na falta deles, entra um marcador com nome.

Servidor e autenticação com critérios claros

Basic, Bearer e API Key em cabeçalho ou query têm mapeamento definido. Na conversão inversa, a prioridade é operação, caminho e raiz, usando o primeiro servidor efetivo. Alternativas múltiplas, ausência de servidor e combinações complexas de segurança são relatadas.

Variáveis em um arquivo separado

As variáveis de ambiente vêm de um JSON exportado separadamente. Valores escalares ativos viram strings e null vira vazio. As aspas preservam espaços, quebras de linha e cifrões literais. Chaves inválidas ou repetidas interrompem a exportação.

O que continua exigindo revisão

Versões aceitas
A entrada aceita Collection 2.1 e OpenAPI 3.0.x ou 3.1.x. Swagger 2.0, outras versões de coleção e OpenAPI 3.2 são recusados. A especificação gerada usa sempre 3.0.3; formatar não significa migrar a versão de um documento.
Sem execução de scripts
Scripts de pré-requisição e testes não são executados nem traduzidos em asserções. A formatação preserva o texto; a conversão relata sua omissão. Variáveis dinâmicas não são avaliadas, e os escopos de ambiente, globais ou Vault não são mesclados automaticamente.
Não há ida e volta sem perdas
A conversão inversa omite definições de resposta e restrições de validação e registra isso no relatório. Serialização complexa, callbacks, webhooks, fluxos OAuth, assinaturas e conteúdo de arquivos binários ficam fora do mapeamento. Exemplos não comprovam todas as regras do serviço.
Referências e endereços incompletos
Referências externas não são buscadas. Alvos locais ausentes ou especificações inválidas interrompem o processo. Uma variável base de coleção não resolvida gera servidor /; sem servidor no sentido inverso, usa-se example.invalid. Ambos exigem revisão do relatório.
Mascaramento tem alcance limitado
Reconhece nomes sensíveis, variáveis secret, valores de autenticação, cookies e credenciais em URLs. Corpos JSON são inspecionados; os demais são mascarados por inteiro. Texto livre e scripts ainda podem conter segredos. A entrada original permanece intacta.
Limites explícitos de processamento
Até 500.000 caracteres de entrada, profundidade 60, 50.000 nós, 1.000 requisições, 500 avisos, 2.000.000 caracteres no resultado completo e cinco segundos de execução. Chaves duplicadas, números imprecisos, aliases YAML, tags próprias e vários documentos são recusados.

Dúvidas sobre Postman para OpenAPI

O conversor aceita especificações YAML e JSON?

Sim, no modo OpenAPI → coleção. Coleções e ambientes devem ser fornecidos em JSON. A escolha de formato só vale para a especificação gerada; a coleção sai em JSON e o ambiente em .env.

A conversão entre os formatos perde informações?

Sim. Um fluxo executável e um contrato declarativo carregam informações distintas. Revise cada aviso e trate a saída como ponto de partida da migração. Converter não verifica credenciais nem respostas de um serviço real.

Como definir baseUrl em uma coleção gerada?

A prioridade é operação > caminho > raiz. A primeira URL efetiva vira baseUrl e as operações seguintes recebem variáveis base separadas. Valores padrão das variáveis de servidor são aplicados. Sem servidor, example.invalid é inserido e relatado.

É possível impedir a exportação de variáveis secretas?

Mantenha o mascaramento ativo para trocar valores secret ou reconhecidos pelo nome por [REDACTED]. Isso controla a saída desta ferramenta, sem alterar as permissões de exportação do Postman. Não é possível identificar todo segredo em texto arbitrário.

A exportação da coleção inclui todas as variáveis de ambiente?

Não automaticamente. Exporte o ambiente à parte e escolha Ambiente → .env. Só os valores ativos desse arquivo são processados. Valores locais, globais ou de Vault ausentes não são recuperados.

Seu documento gerou um resultado inesperado?

Comece com uma coleção pequena

Use Postman para OpenAPI com poucas requisições, compare a lista e o relatório com o original e complete os marcadores pendentes antes de salvar o arquivo para a próxima etapa.