Compressor de JSON do OpenAPI / Swagger
Cole uma especificação JSON do OpenAPI 3.x ou Swagger 2.0 para remover descrições, exemplos e extensões x-: reduz o tamanho da especificação para pipelines de geração de SDK e importações em gateways de API. Roda inteiramente no seu navegador, sem cadastro.
Paste an OpenAPI 3.x or Swagger 2.0 JSON specification to remove descriptions, examples, and x- extensions - reduces spec size for SDK generation pipelines and API gateway imports. Runs entirely in your browser.
Compression Options
Por que usar nosso compressor de OpenAPI?
- Compressão de especificações OpenAPI instantânea: cole qualquer especificação JSON do OpenAPI 3.x ou Swagger 2.0 e comprima-a instantaneamente no seu navegador: remove descrições, exemplos e extensões x- em milissegundos.
- Compressor de OpenAPI online seguro: sua especificação de API nunca sai do seu dispositivo. Toda a compressão roda localmente no navegador: seguro para especificações internas ou proprietárias que contêm informações sensíveis de endpoints.
- Opções de compressão granulares: escolha exatamente o que remover (descrições, resumos, exemplos, extensões x-, sinalizadores obsoletos ou espaços em branco do JSON) com uma pré-visualização ao vivo da saída comprimida.
- 100% grátis para sempre: comprima quantas especificações OpenAPI precisar, totalmente de graça. Sem conta, sem assinatura, sem limites de tamanho de arquivo e sem anúncios.
O que é a compressão de especificações OpenAPI?
A compressão de especificações OpenAPI é o processo de remover campos apenas de documentação de uma especificação JSON do OpenAPI para reduzir seu tamanho em casos de uso programáticos como geração de SDK, importações em gateways de API e pipelines de CI/CD. Especificações OpenAPI grandes podem chegar a vários megabytes quando incluem descrições verbosas, exemplos em linha e campos de extensão do fornecedor, nenhum dos quais é necessário para a geração de código. Nosso compressor de OpenAPI gratuito remove esses campos no seu navegador e mostra exatamente o que foi removido.
Como funciona nosso compressor de OpenAPI
- Cole sua especificação: copie sua especificação JSON do OpenAPI 3.x ou Swagger 2.0 e cole no painel de entrada. Use o botão de exemplo para carregar uma especificação de amostra.
- Escolha as opções de compressão: selecione quais campos remover (descrições, resumos, exemplos, extensões x-, sinalizadores obsoletos ou espaços em branco do JSON). A saída é atualizada instantaneamente.
- Copie ou baixe: copie a especificação comprimida para a área de transferência ou baixe-a como arquivo .json e use no seu gerador de SDK ou gateway de API.
O que é removido durante a compressão
- Descrições: todos os campos "description" de caminhos, operações, parâmetros, corpos de requisição, respostas e esquemas: apenas documentação, não são usados pelos geradores.
- Exemplos: os campos "example" e "examples" de esquemas e parâmetros: usados apenas para renderizar a documentação.
- Extensões x-: todos os campos de extensão do fornecedor que começam com x-: metadados internos adicionados por ferramentas de gestão de API.
- Espaços em branco do JSON: toda a indentação, quebras de linha e espaços entre tokens: produz uma saída JSON minificada em uma única linha.
O que é preservado
Todos os campos estruturais necessários para geração de SDK e importações em gateways de API são totalmente preservados: caminhos, métodos HTTP, IDs de operação, parâmetros (name, in, required, schema), corpos de requisição, códigos de status de resposta, esquemas de resposta, definições de componentes, esquemas de segurança e URLs de servidor. A especificação comprimida é funcionalmente idêntica à original para todos os casos de uso programáticos.
Perguntas frequentes
Um compressor de OpenAPI remove campos verbosos como descrições, exemplos e extensões x- das especificações JSON do OpenAPI para reduzir seu tamanho para geração de SDK, importações em gateways de API e pipelines de CI/CD. Nosso compressor de OpenAPI online gratuito roda inteiramente no seu navegador: sem cadastro nem upload para servidores.
Não. Os geradores de SDK (OpenAPI Generator, Swagger Codegen, Kiota) usam apenas os campos estruturais: caminhos, operações, parâmetros, corpos de requisição, esquemas de resposta e definições de componentes. Descrições e exemplos são campos apenas de documentação que não afetam o código gerado.
Sim, a privacidade completa é garantida. Toda a compressão roda no lado do cliente no seu navegador. Sua especificação do OpenAPI, que pode conter caminhos internos de endpoints, esquemas de autenticação e modelos de dados proprietários, nunca sai do seu dispositivo e nunca é enviada a nenhum servidor.
Sim. O compressor de OpenAPI é 100% gratuito, sem cadastro, sem assinatura, sem limites de tamanho de especificação e sem anúncios. Você pode comprimir quantas especificações precisar.
No OpenAPI 3.x, "summary" é uma descrição curta de uma linha de uma operação (mostrada na navegação da documentação da API), enquanto "description" é uma explicação mais longa em formato markdown. Ambos são campos apenas de documentação: removê-los não tem efeito na geração de SDK nem no comportamento do gateway de API.
Campos de extensão x- são metadados específicos do fornecedor adicionados por ferramentas de gestão de API, gateways ou ferramentas internas (por exemplo, x-rate-limit, x-internal-id, x-amazon-apigateway-integration). É seguro removê-los para geração de SDK, mas podem ser necessários para importações específicas em gateways de API. Consulte a documentação do seu gateway antes de removê-los.
Sim. O compressor funciona com especificações JSON do Swagger 2.0 (swagger: "2.0") e do OpenAPI 3.0/3.1 (openapi: "3.x.x"). Os mesmos campos (descrições, exemplos, extensões x-) existem nos dois formatos e são removidos pela mesma lógica.
A versão atual do compressor só suporta entrada JSON. Para comprimir uma especificação em YAML, converta-a primeiro para JSON com um conversor de YAML para JSON e depois comprima aqui.