跳到主要内容

状态码字典

功能概述​

状态码（错误码）字典是用于集中管理和维护接口文档中所有错误码信息的核心功能模块。它提供了完整的错误码管理能力，确保团队能够高效维护和使用标准化的错误码体系。同时支持AI智能提取

核心价值​

📚 集中管理 - 统一维护所有接口错误码
✏️ 便捷编辑 - 支持多种编辑方式
🔄 实时同步 - 变更自动同步到接口文档
👁️ 直观呈现 - 清晰展示错误码以及错误码描述详情

使用步骤​

1. 访问错误码字典​

通过左侧导航栏进入「项目设置 - 错误码字典」模块

image.png

2. 添加错误码​

  • 单条添加：填写完整错误码信息

image.png

  • 批量编辑：通过错误码:描述信息的格式进行批量编辑修改

image.png

  • AI智能导入：通过复制粘贴AI智能识别，可支持多语言。
    查看使用文档

3. 编辑现有错误码​

直接点击修改或使用批量编辑，同第二步的操作

4. 调整展示顺序​

  1. 鼠标点击拖拽的icon
  2. 拖拽错误码项到目标位置

image.png

5. 保存变更​

  1. 完成所有编辑后，点击顶部「保存」按钮

image.png

6. 文档呈现​

在分享的接口文档中会自动携带状态码的说明

image.png

常见问题​

Q: 为什么修改后没有立即生效？​

A: 所有编辑操作需要手动点击保存按钮才会生效，这是为了防止误操作。

Q: 如何批量更新错误码？​

A: 使用「批量编辑」功能，通过错误码:描述信息的格式进行批量编辑修改。完成后点击顶部「保存」按钮进行保存

技术支持​

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