一、全局响应码

1.1、编码规范

类型 范围 备注
成功 200
资源异常 4xx 请求找不到、限流等
服务器异常 5xx
基础组件异常 5000xx hystrix、feign等
业务异常 6xxyyzz xx标识大模块编码、yy标识功能、zz标识具体异常，详情见以下编码表说明

1.2、已知编码

响应码 响应解释
200 请求成功
400 请求不完整
401 未授权
404 请求找不到
429 请求限流，单位时间内超出zuul网关请求限额
500 请求失败
501 请求未实现或未开启
502 Fallback异常
50001 网关超时
50002 服务不可用
50003 客户端调用异常
50004 网络连接错误
50005 网络超时
50006 Hystrix断路器超时
50007 Hystrix线程池已满
50008 Hystrix断路器已打开
50009 Hystrix信号量未获取
6010101 非法请求
6010102 IP被禁止
6010103 未授权
6010104 接口限流
6020101 授权ID或密钥错误
6020102 授权码错误
6020103 未登录
6020104 登录异常
6020105 验证码错误
6020106 用户名或密码错误
6020107 用户未激活
6020108 用户过期
6020109 密码过期
6020110 用户被禁用
6020111 用户被锁定
6020112 未知账号
6020113 未知部门
6020114 未知岗位
6020201 非法token
6020202 授权类型不支持
6020301 token过期
6030201 公告异常
6030501 数据字典异常
6030502 分类异常
6030503 分类标识异常
6030504 地理区域异常
6030601 安全设置异常
6030602 系统资源异常
6030603 子系统异常
6030604 权限配置异常
6030605 权限定义异常
6030606 桌面管理异常
6030607 授权管理异常
6030608 app系统资源异常
6030701 常用脚本异常
6030702 条件脚本异常
6030703 脚本管理异常
6030801 服务后置事件异常
6030802 服务管理异常
6040001 参与者异常
6040101 参与者等级异常
6040201 参与者属性异常
6040301 角色异常
6040401 机构异常
6040501 岗位异常
6040601 员工异常
6040701 分级机构异常
6040801 用户组异常
6040901 租户异常
6041001 参与者关系异常
6050000 流程异常
6050100 流程定义异常
6050200 流程实例异常
6050300 流程任务异常
6050400 流程监控异常
6050500 流程统计异常
6060000 表单异常
6060100 数据集异常
6060200 表单设计器异常
6060300 表单渲染异常
6060400 数据模版异常
6060500 业务数据模版异常
6060600 业务对象异常
6070201 外部邮件用户设置异常
6070202 外部邮件异常
6070203 内部消息异常
6070204 内部消息已读异常
6070205 内部消息回复异常
6070206 消息已读异常
6070207 接收人异常
6070208 消息回复异常
6070209 消息回复异常
6070210 消息类型异常
6070401 定时任务异常
6070402 定时任务已存在
6070601 流水号异常
6070602 流水号别名已存在
6070603 流水号测试异常
6070301 附件操作失败
6080000 代码生成器异常
6080001 代码生成器生成方案异常
6080002 代码生成器表配置异常
6080003 代码生成器模板异常
6080004 代码生成器变量异常
6090001 SOCKET文件消息异常

二、请求格式

2.1、APIRequest

名称 类型 备注
parameters List< Object> 参数键值对
requestPage Object 分页参数
sorts List< Object> 排序字段

2.2、请求示例：

{
  "parameters": [
    {
      "key": "name",
      "value": "张三"
    },
    {
      "key": "age",
      "value": "22"
    }
  ],
  "requestPage": {
    "limit": 15,
    "pageNo": 1
  },
  "sorts": [
    {
      "field": "ID_",
      "order": "asc"
    }
  ]
}

三、响应格式

3.1、响应说明

名称 类型 备注
state int 响应编码，更多响应码请移全局响应码
request String 请求地址uri
message String 响应内容，正常响应的消息
cause String 异常内容，异常响应的错误信息
data T 数据体，后端对应一个泛型对象
variables Map 变量集，后端将前端所需的非数据信息返回时可使用变量传递

3.2、响应示例：

{
  "state": 200,
  "request": null,
  "message": "",
  "cause": "",
  "variables": {
    "state": "3d896n"
  },
  "data": "cf5918e0f6bf11e9c2decb30b33a53a6"
}
作者：管理员  创建时间：2023-12-20 11:15
最后编辑：管理员  更新时间：2024-11-25 19:17