Esta ferramenta suporta OpenAPI 3.1?

Sim. Suporta definições OpenAPI 3.1, 3.0 e Swagger 2.0. A ferramenta converte a estrutura subjacente sem alterar a versão da especificação.

A documentação da minha API será mantida privada?

Sim. A conversão acontece inteiramente no seu navegador usando JavaScript. Nenhum dado do documento é enviado para os nossos servidores ou armazenado externamente.

O que acontece aos comentários YAML durante a conversão?

O JSON não suporta comentários, então quaisquer comentários na sua fonte YAML serão removidos ao converter para JSON. São preservados se estiver apenas a formatar YAML.

A saída é validada em relação ao esquema OpenAPI?

A ferramenta verifica a sintaxe `YAML` e `JSON` válida durante o processo de conversão. Para validação completa ao nível do esquema, recomendamos usar um linter OpenAPI dedicado.

Formatadores e Código

OpenAPI 3.1 YAML ⇄ JSON

Convert OpenAPI specs between YAML and JSON.

Runs in your browser

OpenAPI YAML · source

lines: 42chars: 924size: 924 B

JSON · result

{
  "openapi": "3.0.3",
  "info": {
    "title": "AnytimeConvert API",
    "version": "1.0.0"
  },
  "paths": {
    "/tools": {
      "get": {
        "summary": "List all tools",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Tool"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/tools/{slug}": {
      "get": {
        "summary": "Get a tool by slug",
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tool"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Tool": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string"
          }
        },
        "required": [
          "slug",
          "name",
          "category"
        ]
      }
    }
  }
}

lines: 79chars: 1576size: 1.5 KB

live

Nota do editor

Understanding · Same spec, two file formats — pick by audience.

Este capítulo aprofundado está disponível apenas em inglês no momento. A ferramenta de conversão acima funciona no seu idioma; o artigo explicativo longo ainda não foi traduzido.

Perguntas frequentes

Quick answers.

›Does this tool support OpenAPI 3.1?

Yes. It supports OpenAPI 3.1, 3.0, and Swagger 2.0 definitions. The tool converts the underlying structure without altering the specification version.

›Will my API documentation be kept private?

Yes. The conversion happens entirely in your browser using JavaScript. No document data is sent to our servers or stored externally.

›What happens to YAML comments during conversion?

JSON does not support comments, so any comments in your YAML source will be stripped when converting to JSON. They are preserved if you are simply formatting YAML.

›Is the output validated against the OpenAPI schema?

The tool checks for valid `YAML` and `JSON` syntax during the conversion process. For full schema-level validation, we recommend using a dedicated OpenAPI linter.

As pessoas também pesquisam por

Ferramentas relacionadas

More in this room.

Ver tudo em Formatadores e Código