OpenAPI 3 接口文档查看器

粘贴或打开 OpenAPI 3.0/3.1 文档,查看概览、端点与数据模型,一键导出 Markdown,全程本地处理

输入文档 支持 JSON / YAML,上限 5MB,不上传
Markdown 导出口径

章节顺序:固定为 # 标题 → ## 概览 → ## 端点 → ## 数据模型,不随文档内容增删章节。

端点排版:按第一个 tag 分组为 ### 标签,每个端点写成 #### `METHOD` `/路径`,随后是摘要与 operationId/标签/废弃信息;参数、请求体、响应各自成 ##### 小节。

表格字段:参数表为「名称 / 位置 / 必填 / 类型 / 描述」;请求体先写「必填:是/否」,表格为「媒体类型 / 类型 / 示例」,对象与数组示例压成单行 JSON;响应表为「状态码 / 描述 / 媒体类型」,无 content 写 —。

数据模型:每个 components.schemas 一项 ### 名称,下面是缩进字段树,标注类型、必填与徽标,超过 4 层显示 …。

$ref:只展开文档内 #/ 引用;pathItem、参数、requestBody、responses 容器与单个响应逐层解引用,字段树标注目标名并继续展开,循环引用标「循环引用」后停止;外部、缺失、非法引用保留原 $ref 文本并打标。

示例取值:media 级 example → media 级 examples 首项 → schema 级 example → schema 级 examples 首项 → 按类型占位;schema 为 $ref 时先解引用再取类型与示例。

粘贴文档或点击「加载示例」后,这里显示标题、版本、服务器与统计。

解析成功后,这里按标签分组列出全部端点。

解析成功后,这里列出 components.schemas 中的全部模型。

详情

常见问题

支持哪些 OpenAPI 版本?

只读预览 OpenAPI 3.0.x 与 3.1.x;Swagger 2.0 会提示先转换为 OpenAPI 3,缺失版本或其它版本也会给出明确错误。

文档会上传到服务器吗?

不会。解析、渲染与导出都在浏览器本地完成,不发起任何网络请求,适合处理含敏感字段的接口文档。

$ref 和 allOf / oneOf 能展开吗?

支持文档内 #/ 开头的 JSON Pointer 引用,pathItem、参数、请求体、响应容器与每个响应会逐层解引用;allOf 合并展示,oneOf/anyOf 显示为一层变体,循环引用会标记并停止展开。

哪些特性不支持?

跨文件或 URL 引用、Swagger 2.0、webhooks、callbacks 与 link 不解析;oneOf/anyOf 只展开一层变体,不做联合校验。