Ir para o conteúdo
Totalmente local

Coleção OpenAPI para Postman

Converta um documento OpenAPI ou Swagger numa coleção Postman v2.1 pronta para importação.

Entrada

Coleção OpenAPI para Postman

Cole um documento OpenAPI 3 ou Swagger 2 — JSON ou YAML — e esta ferramenta constrói uma coleção Postman v2.1 que pode importar diretamente para Postman, Insomnia ou qualquer cliente que leia o formato. Cada operação na especificação torna-se um pedido, organizado em pastas para que uma API grande permaneça navegável em vez de ser descarregada como uma lista única e plana.

Agrupe pedidos por tag ou pelo primeiro segmento de caminho, consoante o que melhor corresponda ao modo como a sua equipa já pensa sobre a API. Ative "Inserir URL base como variável de ambiente" para substituir o URL do servidor por uma variável {{baseUrl}}, permitindo que mudar entre ambiente de produção e teste seja uma única alteração de ambiente em vez de editar cada pedido. "Adicionar cabeçalhos de autenticação do esquema de segurança" lê as definições de bearer, chave de API ou OAuth2 da especificação e adiciona o cabeçalho Authorization ou chave correspondente como marcador. "Gerar corpos de pedido de exemplo a partir de esquemas" constrói um exemplo JSON para cada pedido baseado no seu esquema, seguindo as referências $ref dentro do documento, permitindo que pedidos POST e PUT cheguem pré-preenchidos em vez de vazios. Os parâmetros de consulta podem ser incluídos com as suas descrições, os terminais obsoletos podem ser completamente omitidos, e um script de teste básico que verifica um código de estado bem-sucedido pode ser adicionado a cada pedido.

Os parâmetros de caminho como {id} tornam-se variáveis de caminho :id do Postman automaticamente, e os términos de linha CRLF e LF num documento colado são tratados da mesma forma. As especificações grandes com centenas de operações são convertidas numa única passagem; se a coleção ultrapassasse o limite de produção, a ferramenta avisa em vez de congelar a aba.

Tudo ocorre localmente no seu navegador — o documento que cola, incluindo qualquer detalhe de API interno que contenha, nunca é carregado em nenhum lugar. Quando a coleção está pronta, copie-a, transfira-a como um ficheiro ou envie-a para a entrada de outra ferramenta para continuar a trabalhar.

FAQ

Suporta tanto documentos OpenAPI 3 quanto Swagger 2?
Sim. Lê os "servers" e "components.securitySchemes" do OpenAPI 3 bem como "host"/"basePath"/"schemes" e "securityDefinitions" do Swagger 2, e aceita tanto JSON como YAML.
Quais esquemas de segurança é que reconhece?
Autenticação HTTP bearer e básica, chaves de API num cabeçalho, parâmetro de consulta ou cookie, e OAuth2/OpenID Connect — cada um mapeia para o cabeçalho de marcador ou parâmetro de consulta correspondente.
Como é que são gerados os corpos de pedido de exemplo?
A partir dos valores "example" ou "default" do próprio esquema da pedido onde presentes, recuando para um marcador apropriado ao tipo — as referências $ref são resolvidas dentro do mesmo documento.
O que acontece a $ref que apontam para fora do documento?
Resolvem para null no exemplo gerado em vez de serem seguidas em qualquer lugar — nada nesta ferramenta faz jamais um pedido de rede.
É que o meu documento de API é carregado em algum lugar?
Não. A conversão ocorre inteiramente no seu navegador — o documento e tudo o que contém permanecem no seu dispositivo.