Поддерживает ли этот инструмент OpenAPI 3.1?

Да. Он поддерживает определения OpenAPI 3.1, 3.0 и Swagger 2.0. Инструмент преобразует базовую структуру, не изменяя версию спецификации.

Будет ли моя документация API оставаться конфиденциальной?

Да. Преобразование полностью происходит в вашем браузере с использованием JavaScript. Никакие данные документа не отправляются на наши серверы и не хранятся извне.

Что происходит с комментариями YAML при преобразовании?

JSON не поддерживает комментарии, поэтому любые комментарии в вашем исходном коде YAML будут удалены при преобразовании в JSON. Они сохраняются, если вы просто форматируете YAML.

Проверяется ли вывод на соответствие схеме OpenAPI?

Инструмент проверяет синтаксис `YAML` и `JSON` на допустимость в процессе преобразования. Для полной проверки на уровне схемы мы рекомендуем использовать специализированный линтер OpenAPI.

Форматтеры и код

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

Примечание редактора

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

Эта углублённая глава пока доступна только на английском языке. Инструмент конвертации выше работает на вашем языке; развёрнутая статья ещё не переведена.

Часто задаваемые вопросы

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.

Люди также ищут

Связанные инструменты

More in this room.

Смотреть все в Форматтеры и код