Formatador OpenAPI que embeleza e valida specs Swagger e OpenAPI em JSON ou YAML, contando paths e operações.
Formatador OpenAPI
Formatador OpenAPI que embeleza e valida specs Swagger e OpenAPI em JSON ou YAML, contando paths e operações.
Esta é uma ferramenta local: roda inteiramente no seu navegador. A spec OpenAPI ou Swagger que você cola nunca sai do seu dispositivo — nada é enviado à ArrayKit ou a qualquer servidor.
O formatador OpenAPI da ArrayKit embeleza e valida especificações OpenAPI e Swagger em JSON ou YAML, tudo dentro do seu navegador. Cole uma spec e ele analisa o documento, reporta a versão detectada (OpenAPI 3.x ou Swagger 2.0), o título da API e conta quantos paths e operações ela define, depois reemite JSON ou YAML limpo e indentado de forma consistente. Foi feito para desenvolvedores de backend e de API, redatores técnicos e equipes de plataforma que precisam de uma forma rápida de arrumar um contrato editado à mão, converter entre JSON e YAML ou conferir uma spec antes de colocá-la em commit ou alimentá-la ao Swagger UI, a geradores de código ou a um gateway. Como a montagem da requisição e a análise acontecem localmente, você pode formatar definições de API internas ou não lançadas sem enviá-las a um servidor. Use-o para detectar YAML malformado, confirmar contagens de operações e padronizar a formatação em um repositório.
Recursos
Aceita entrada em JSON e YAML — JSON é YAML válido, então qualquer um é analisado
Detecta e rotula a versão da spec: OpenAPI 3.x ou Swagger 2.0
Reporta o título da API mais uma contagem ao vivo de paths e operações
Conta as oito operações HTTP (get, put, post, delete, options, head, patch, trace)
Alterne a saída entre JSON formatado e YAML com 2 espaços
Exibe erros de análise com a mensagem subjacente quando um documento é malformado
Avisa quando não há campo openapi ou swagger para que specs desconhecidas se destaquem
Baixe o resultado formatado como openapi.json ou openapi.yaml
Como usar Formatador de OpenAPI / Swagger
Cole sua spec OpenAPI ou Swagger (JSON ou YAML) no painel de entrada
Escolha o formato de saída com o alternador JSON / YAML na barra de ferramentas
Leia o banner de resumo com a versão, o título, a contagem de paths e a de operações
Copie a spec formatada ou baixe-a como openapi.json ou openapi.yaml
Exemplo
Entrada
openapi: 3.0.3
info: { title: Example API, version: 1.0.0 }
paths:
/users:
get: { summary: List users, responses: { '200': { description: OK } } }
post: { summary: Create user, responses: { '201': { description: Created } } }
Saída
openapi: 3.0.3
info:
title: Example API
version: 1.0.0
paths:
/users:
get:
summary: List users
responses:
'200':
description: OK
post:
summary: Create user
responses:
'201':
description: Created
Uma spec mínima OpenAPI 3.0 — o formatador reporta 'OpenAPI 3.0.3 · Example API · 1 path · 2 operations'.
Erros comuns e solução de problemas
O resumo mostra 'Unknown — no openapi/swagger field'. — Adicione um campo de nível superior openapi: 3.x.x (ou swagger: '2.0'); sem ele a versão não pode ser detectada, mesmo que o documento ainda seja formatado.
Aparece um erro de análise de YAML, muitas vezes sobre indentação ruim ou um caractere de tabulação. — YAML é sensível à indentação e proíbe tabulações — substitua tabulações por espaços e alinhe as chaves de forma consistente, depois cole novamente.
A contagem de operações parece menor do que o esperado. — Apenas os oito métodos HTTP padrão são contados; extensões de fornecedor como x-amazon-apigateway-integration e entradas de parameters/servers não são operações.
'The document is empty or not an object' após colar. — A entrada foi analisada como um escalar ou null — certifique-se de ter colado todo o objeto da spec, não uma única string ou um fragmento parcial.
Perguntas frequentes
O que é um formatador OpenAPI / Swagger?
É uma ferramenta que analisa uma especificação de API OpenAPI 3.x ou Swagger 2.0 e a reemite como JSON ou YAML limpo e indentado de forma consistente, enquanto reporta a versão e o número de paths e operações para que você revise e padronize uma spec rapidamente.
Ele suporta specs tanto em JSON quanto em YAML?
Sim. Como o próprio JSON é YAML válido, você pode colar qualquer um dos formatos. Use o alternador JSON / YAML para escolher como a saída formatada é emitida, o que também permite converter uma spec de um formato para o outro.
Ele valida completamente minha spec contra o schema do OpenAPI?
Ele valida que o documento é analisado como JSON ou YAML bem formado e detecta a versão, o título, os paths e as operações. Ele não executa a validação completa de JSON Schema de cada campo, então não sinalizará uma propriedade obrigatória ausente no fundo de uma operação.
Quais versões ele reconhece?
Ele rotula OpenAPI 3.x pelo campo openapi e Swagger 2.0 pelo campo swagger. Qualquer documento sem um desses campos é formatado, mas marcado como versão desconhecida.
Minha spec de API é enviada para algum lugar?
Não. A análise, a validação e a formatação rodam inteiramente no seu navegador. A spec que você cola nunca sai do seu dispositivo e nada é enviado à ArrayKit, então contratos de API internos ou não lançados permanecem privados.
Posso baixar o resultado formatado?
Sim. A spec formatada pode ser copiada ou baixada como openapi.json ou openapi.yaml, dependendo do formato de saída que você selecionou.
Ferramentas relacionadas
YAML ↔ JSON — Converta YAML para JSON e vice-versa.
Formatador de JSON — Embeleze, minifique e valide JSON com a localização dos erros.
Formatador de GraphQL — Formate ou minifique consultas e esquemas GraphQL, valide a sintaxe e extraia operações.
Formatador de XML — Embeleze, minifique e valide XML, e converta XML ↔ JSON.
Cliente de API — Envie requisições HTTP, monte cabeçalhos e parâmetros e inspecione respostas; salva as últimas 25.
cURL para Fetch — Converta um comando curl em uma chamada fetch() de JavaScript.
Visualizador de JSON — Visualizador de texto e árvore recolhível com expandir/recolher e caminhos de nós.