OpenAPI 编辑器
OpenAPI Spec
▼
查看源文件
导入OpenAPI Spec文件
导出OpenAPI Spec文件【YAML】
导出OpenAPI Spec文件【JSON】
文档
▼
查看整体文档
导出为HTML文档
导出为PDF文档
保存
加载
▼
加载 OpenAPI Spec 文件
从云端加载
加载示例
接口管理
+
▼
请导入 OpenAPI 文件
数据模型
+
▼
暂无数据模型
接口文档要交付给客户？
本工具可导出 HTML 接口文档。如果还需要排版规范的 Word / PDF 说明书，可以把补充说明写成 Markdown，再用同一作者出品的
Markdown 文档排版工具 markdown6
导出。
📄
请选择接口或数据模型
从左侧列表中选择一个接口或数据模型查看详情
新建接口
×
HTTP 方法
*
GET
POST
PUT
DELETE
PATCH
HEAD
OPTIONS
路径
*
支持路径参数，如：/api/v1/users/{userId}
摘要
标签
用于分类，多个标签用逗号分隔
服务器配置
×
+ 添加服务器
编辑字段
×
字段名称
*
字段类型
*
STRING
NUMBER
INTEGER
BOOLEAN
ARRAY
OBJECT
描述
格式
无
示例值
默认值
无
true
false
引用数据模型
无（使用内联定义）
选择现有的数据模型作为该字段的类型。注意：不能产生循环依赖。
允许为空（nullable）
数值约束
最小值
最大值
长度约束
最小长度
最大长度
正则表达式
用于验证字符串格式的正则表达式
枚举值
每行一个值，或使用逗号分隔多个值
API 信息
×
标题
*
版本
*
描述
支持 Markdown 格式
服务条款 URL
联系人姓名
联系人邮箱
联系人 URL
许可证名称
许可证 URL
Tags 管理
×
Tags 管理
接口归属管理
+ 添加 Tag
筛选接口
认证管理
×
认证方案定义
全局认证策略
+ 添加认证方案
勾选的方案将作为所有接口的默认认证要求。单个接口可在详情页中覆盖此设置。
查看原始文件
×
YAML
JSON
选择数据模型
×
添加响应
×
状态码
*
200 - OK (成功)
201 - Created (已创建)
202 - Accepted (已接受)
204 - No Content (无内容)
301 - Moved Permanently (永久重定向)
302 - Found (临时重定向)
304 - Not Modified (未修改)
400 - Bad Request (请求错误)
401 - Unauthorized (未授权)
403 - Forbidden (禁止访问)
404 - Not Found (未找到)
405 - Method Not Allowed (方法不允许)
409 - Conflict (冲突)
422 - Unprocessable Entity (无法处理)
429 - Too Many Requests (请求过多)
500 - Internal Server Error (服务器错误)
501 - Not Implemented (未实现)
502 - Bad Gateway (网关错误)
503 - Service Unavailable (服务不可用)
504 - Gateway Timeout (网关超时)
自定义状态码...
自定义状态码
*
描述
*
从云端加载
×
暂无云端 API 规范
调试历史记录
×
本地历史
云端历史
暂无本地调试历史记录
暂无云端调试历史记录