此工具是否支持 OpenAPI 3.1？

是的。它支持 OpenAPI 3.1、3.0 和 Swagger 2.0 定义。该工具转换底层结构而不改变规范版本。

我的 API 文档会保密吗？

是的。转换完全在您的浏览器中使用 JavaScript 进行。文档数据不会发送到我们的服务器或外部存储。

转换期间 YAML 注释会怎么样？

JSON 不支持注释，因此在转换为 JSON 时，YAML 源代码中的任何注释都将被删除。如果您只是格式化 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.

查看所有格式化与代码