OpenAPI / Swagger Formatter

Format and validate OpenAPI / Swagger specs (JSON or YAML) and count paths and operations.

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.

Converter entre YAML e JSON

Sobre OpenAPI / Swagger Formatter

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

Como usar OpenAPI / Swagger Formatter

  1. Cole sua spec OpenAPI ou Swagger (JSON ou YAML) no painel de entrada
  2. Escolha o formato de saída com o alternador JSON / YAML na barra de ferramentas
  3. Leia o banner de resumo com a versão, o título, a contagem de paths e a de operações
  4. 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

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

Todas as ferramentas de ArrayKit