sublime text 可通过插件组合高效编写、校验和预览 openapi 文档：安装 yaml、openapi specification、autofilename 等插件实现语法高亮与补全；用 snippet 快速生成路径模板；通过 openapi-cli 本地校验或 swagger editor 在线验证；支持拖入预览、redoc-cli 生成静态页或 browser preview 实时刷新。
Sublime Text 本身不原生支持 Swagger / OpenAPI 文档的编写与渲染，但通过合理搭配插件和工作流，完全可以高效编写、校验和预览符合 OpenAPI 3.0+ 规范的 API 接口文档（如 openapi.yaml 或 openapi.json）。关键在于语法支持、实时校验、快速补全和轻量预览。
安装核心插件提升编写体验
推荐组合使用以下 Sublime 插件（通过 Package Control 安装）：
- YAML：Sublime 自带或增强版，确保 .yaml/.yml 文件正确高亮和缩进
- OpenAPI Specification：专为 OpenAPI 设计，提供语法高亮、结构折叠、错误提示（基于内置 schema）
-
AutoFileName：在引用 external $ref 时自动补全文件路径（如
$ref: './paths/users.yaml'） - EditorConfig（可选）：统一团队的缩进、换行等格式，避免 YAML 格式错误
用 snippet 快速生成常用 OpenAPI 片段
Sublime 支持自定义代码片段（snippets），可大幅减少重复输入。例如创建一个 openapi-path-get.sublime-snippet：
<snippet>
<content><![CDATA[
${1:pathName}:
get:
summary: ${2:brief description}
description: ${3:detailed description}
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/${4:ResponseModel}'
]]></content>
<tabTrigger>opget</tabTrigger>
<scope>source.yaml</scope>
</snippet>
输入 opget + Tab 即可展开标准 GET 路径模板，配合变量跳转快速填写。
本地校验 OpenAPI 文件是否合规
仅靠插件高亮不够，需真实校验语法与语义。推荐两种轻量方式：
- 命令行校验：安装
openapi-cli（npm install -g @redocly/cli），在 Sublime 中配置 Build System（Tools → Build System → New Build System），写入：
{
"shell_cmd": "openapi validate "$file"",
"file_regex": "^.*?:(\d+):(\d+):\s+(.*)$",
"working_dir": "$file_path"
}
保存后按 Ctrl+B（Win）/ Cmd+B（Mac）即可运行校验，错误直接跳转到行号。
- 在线辅助：临时粘贴到 Swagger Editor，它会实时标红并提示缺失字段（如
openapi、info）
轻量预览：不用启动服务也能看效果
不想跑 Node 服务？可用以下方式快速预览：
- 将 .yaml 文件拖入 Swagger Editor 页面，自动渲染交互式文档
- 用
@redocly/cli生成静态 HTML：redoc-cli bundle openapi.yaml -o docs.html，双击打开即可 - Sublime 插件 Browser Preview（配合本地 HTTP Server）可一键在浏览器中刷新查看（适合常驻预览）
基本上就这些——不复杂但容易忽略细节：YAML 缩进必须用空格、$ref 路径区分相对/绝对、组件定义建议拆分到 components/ 子目录便于维护。
