跳到主要内容

AI智能提取状态码

功能概述​

AI智能导入错误码信息功能通过智能识别用户粘贴的错误码文档内容，自动解析提取错误码及其描述信息，快速生成标准化的错误码数据，大幅提升错误码录入效率。

核心价值​

⚡ 效率提升 - 自动解析替代手动录入，节省90%以上时间
🔍 智能识别 - 支持多种原始格式的错误码文档
📝 标准输出 - 统一生成"错误码+描述"的标准格式
🔄 批量处理 - 支持一次性导入多个错误码
📚 文档集成 - 自动同步到接口文档状态码字典章节

适用场景​

  • 从旧文档迁移错误码到新系统
  • 从日志/代码注释中提取错误码
  • 整理分散的错误码信息
  • 快速构建API文档的错误码章节
  • 错误码信息的标准化处理

使用步骤​

1. 从左侧菜单栏 「项目设置-状态码字典」进入​

image.png

2. 复制原始错误码信息​

从任意来源复制包含错误码的文本：

/* 
 * 40001: 参数校验失败
 * 40002: 用户未认证
 * 50001: 系统内部错误 - 数据库连接失败
 * 50002: 系统内部错误 - 缓存服务不可用
 */

或非结构化文本：

错误码列表：
- 40400 资源不存在
- 40301 无访问权限(用户角色不符)
- 20000 操作成功

3. 点击"智能导入"并粘贴​

将复制的文本粘贴到输入框，点击"智能导入"按钮：

image.png

4. 预览解析结果​

系统自动识别并格式化输出：

image.png

5. 确认导入，点击保存并最终应用​

  1. 检查自动识别的准确性
  2. 调整修改（可选）
  3. 点击"保存"同步到接口文档
  4. 在文档状态码字段章节查看效果

多格式支持​

可识别的原始格式包括：

  1. 代码注释格式：
// 40001: 无效的用户ID格式
// 40002: 缺少必填参数
  1. 表格格式：
| 错误码 | 说明           |
|--------|----------------|
| 40401 | 用户不存在     |
| 40301 | 权限不足       |
  1. 日志格式：
[ERROR][CODE:50001] 数据库超时
[WARN][CODE:40003] 请求参数不合法

文档集成效果​

在接口文档中自动生成：

image.png

常见问题​

Q: 是否支持错误码多语言？​

A: 支持，可上传多语言版本错误码描述，在解析时可选择目标语言进行解析导入

技术支持​

如有问题或功能建议，请联系我们的技术支持团队或访问开发者社区获取帮助。