Towalles Towalles

OpenAPI 格式化

OpenAPI 3.x 与 Swagger 2.x 规范通常是大型 JSON 或 YAML 文件，提交 PR 前需要可读 diff 与顶层字段自检。本工具格式化 OpenAPI JSON 并检查 openapi/swagger、info、paths 等关键节点是否缺失。YAML 源文件可先用 yaml-converter 转为 JSON，schema 校验请用 structured-output-validator。

阅读完整指南: SQL 与 OpenAPI：格式化、契约与 Mock →

隐私提示：本地解析，不上传服务器。

↓ 在下方输入区粘贴内容，结果会立即显示

粘贴 OpenAPI/Swagger JSON，自动美化并检查基础结构 (openapi、info、paths)。

OpenAPI JSON

格式化结果

{
  "openapi": "3.0.0",
  "info": {
    "title": "API",
    "version": "1.0.0"
  },
  "paths": {}
}

注释说明

说明

仅做 JSON 美化与顶层字段检查; 完整 schema 校验请用 Spectral 或 Redocly 等专业工具。

OpenAPI 3.x 与 Swagger 2.x 规范通常是大型 JSON 或 YAML 文件，提交 PR 前需要可读 diff 与顶层字段自检。本工具格式化 OpenAPI JSON 并检查 openapi/swagger、info、paths 等关键节点是否缺失。YAML 源文件可先用 yaml-converter 转为 JSON，schema 校验请用 structured-output-validator。

快速开始

  1. 粘贴 JSON

    从 Swagger Editor 或代码生成器导出。

  2. 查看输出

    实时格式化; 结构缺失会提示。

  3. 复制

    用于 PR 或文档仓库。

与完整校验的区别

本工具不做 JSON Schema 级校验; 生产环境建议配合 Spectral、Redocly CLI 或 openapi-generator。

隐私

规范 JSON 在浏览器本地处理; 不上传 API 定义。

OpenAPI 结构

openapi/swagger 版本字段、info、paths、components/schemas 是 lint 重点。大 spec 格式化后 json-diff PR 可读性高。

YAML 源文件 yaml-converter 转 JSON 再 format；structured-output-validator 校验 example payload。

Breaking change 审查

删除 path、required 字段、type 变更即 breaking——semver MAJOR bump。formatter 后 diff 聚焦 semantic paths。

url-parser 验证 servers.url 与 production base URL 一致。

文档与 mock

formatted spec 导入 Swagger UI / Redoc；mock server 依赖 schema 一致性。

勿将 internal-only paths 暴露到 public spec export。

示例

最小示例

Input

{"openapi":"3.0.0","info":{"title":"API","version":"1.0.0"},"paths":{}}

Output

Pretty-printed JSON with 2-space indent

FAQ

支持 YAML 吗？

当前仅 JSON; YAML 可先经 YAML 转换工具转为 JSON。

会校验 $ref 吗？

不会; 仅检查顶层结构与 JSON 语法。

Swagger 2 支持吗？

视工具；3.x 优先。

超大 spec 卡吗？

可能；components only 片段格式化。

上传 spec 吗？

否。

与 Postman 导入？

formatted JSON 提高导入成功率。