无需登录 数据私有 本地保存

Swagger 编辑器轻量版 - 在线编写 OpenAPI 规范

32
0
0
0

核心功能详解

1. YAML/JSON 格式切换

工具支持 YAML 和 JSON 两种 OpenAPI 规范格式的编写和切换。YAML 格式使用缩进来表示层级关系,语法简洁直观,是编写 OpenAPI 规范的推荐格式。JSON 格式使用花括号和方括号表示对象和数组,结构严谨,适合程序化处理。用户可以通过工具栏的切换按钮在两种格式之间无缝切换,工具会自动转换已有的内容。切换时会保留用户的编辑内容,并确保格式的正确性。无论选择哪种格式,工具都能提供准确的语法检查和实时预览。

2. 四个预设示例

工具内置了四个精心设计的预设示例,覆盖了不同的 API 设计场景。宠物店 API 示例是 OpenAPI 官方的经典示例,定义了完整的宠物管理接口,包括创建宠物、查询宠物列表、获取宠物详情、更新宠物信息和删除宠物等操作,展示了 OpenAPI 规范的完整用法。用户管理 API 示例演示了用户注册、登录、获取用户信息、更新用户资料和删除用户等常见接口,包含了 JWT 认证配置和请求体定义。待办事项 API 示例展示了一个简洁实用的任务管理接口,包括任务的增删改查和状态切换。最小模板提供了一个最基本的 OpenAPI 3.0 文档结构,只包含必要的信息字段,适合快速开始新项目。

3. 验证、复制、导出和清空

验证功能会检查用户编写的 OpenAPI 规范是否符合标准语法和结构要求。工具会检查必需字段是否存在、数据类型是否正确、引用是否有效等,发现错误时会在预览区域显示详细的错误信息,包括错误位置和修复建议。复制功能将编辑器中的全部内容复制到系统剪贴板,方便用户粘贴到其他编辑器或版本控制系统中。导出功能将内容下载为 YAML 或 JSON 文件,文件名默认为 openapi.yaml 或 openapi.json,用户可以根据需要重命名。清空功能会弹出确认对话框,确认后清除编辑器中的所有内容,避免误操作导致的数据丢失。

4. 实时预览

实时预览功能是本工具的核心特色之一。当用户在编辑器中输入内容时,右侧的预览区域会自动解析并渲染出结构化的 API 文档视图。预览区域以清晰的层次结构展示 API 的基本信息(标题、描述、版本、联系人等)、服务器地址、端点列表(按路径和方法分组)、每个端点的请求参数(路径参数、查询参数、请求头、请求体)、响应格式(状态码、响应体结构)以及认证方式(Bearer Token、API Key、OAuth2 等)。预览采用 Bootstrap 5.3 样式,排版美观,适合直接用于团队内部的 API 文档共享。

5. 行数和字符数统计

编辑器底部的统计栏会实时显示当前文档的行数和字符数。这个信息对于控制文档规模、了解 API 复杂度以及版本比较都非常有用。行数统计帮助开发者了解文档的总体结构规模,字符数统计则更精确地反映了文档的详细程度。当用户从示例加载内容或进行大规模编辑时,统计信息可以帮助快速了解变更的规模。统计信息会在每次编辑后自动更新,无需手动刷新。