API模块详情

← 返回首页

公共请求头（所有接口适用）

参数名	必填	类型	示例	说明
Authorization	否	string	`Bearer <JWT token>`	用户登录后的 JWT 令牌。若已登录可直接使用，无需传 X-Client。。认证 Token，请在请求头中携带，推荐格式：Bearer {token}
X-Client	否	string	`<client key token>`	客户端密钥。当未携带或无法使用 Authorization 时必填，用于密钥认证。线上文档： http://localhost:5601/docs
X-Site	是	string	`<site key>`	站点标识（必填）。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。
X-System-Code	是	string	`AUTH_MANAGEMENT`	系统编码（必填）。用于指定当前访问的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。

API响应码列表

共 45 个响应码

API响应码说明。所有接口统一返回HTTP 200状态码，业务状态通过响应体中的code字段表示。点击展开

成功响应码 (1个)

参数名	必填	类型	示例	说明
0000	否	string	`操作成功`	请求处理成功，这是所有成功响应的标准代码

错误响应码 (44个)

参数名	必填	类型	示例	说明
1001	否	string	`缺少令牌`	请求中缺少必要的令牌（访问令牌、登录令牌、注册令牌等）
1002	否	string	`令牌无效或已过期`	提供的令牌格式错误、无法解析、已过期或信息不完整
1003	否	string	`会员不存在`	指定的会员记录在系统中不存在
1004	否	string	`会员状态无效`	会员状态不是有效状态（非启用状态）
1005	否	string	`会员已过期`	会员的有效期已过
1006	否	string	`系统未开放或已停用`	请求的系统代码对应的系统未启用、不存在或已被停用
1007	否	string	`会员类型未授权当前系统`	当前会员类型未配置访问该系统的权限，或会员码不支持当前系统
1008	否	string	`系统模块未开放访问`	请求的系统模块未启用或不存在
1009	否	string	`会员未开通该功能模块`	会员未开通请求的功能模块
1010	否	string	`当前模块的使用已达到上限`	模块使用次数已达到配置的上限值
1103	否	string	`账号已被加入黑名单`	账号已被加入黑名单，无法执行操作或登录
1104	否	string	`会员类型不存在或已停用`	指定的会员类型不存在或已被停用
1105	否	string	`订单不存在`	指定的订单记录在系统中不存在
1106	否	string	`订单手机号与当前账号不匹配`	订单关联的手机号与当前登录账号的手机号不一致
1107	否	string	`订单尚未支付或已失效`	订单状态不是已支付或已完成状态
1108	否	string	`订单类型与会员类型不匹配`	订单的会员类型与请求的会员类型不一致
1109	否	string	`管理员角色未配置`	系统中未找到管理员角色配置
1201	否	string	`密码需包含字母和数字，且不少于6位`	密码不符合要求：必须包含字母和数字，且长度不少于6位（适用于注册和登录）
1202	否	string	`手机号已注册系统用户`	该手机号已被注册为系统用户
1203	否	string	`公司信用代码已注册`	该公司信用代码已被注册
1204	否	string	`手机号已注册客户端用户`	该手机号已被注册为客户端用户
1210	否	string	`站点标识生成失败，请稍后重试`	生成站点标识时发生错误
1211	否	string	`拒绝无效访问`	站点标识无效或访问被拒绝
1303	否	string	`请同意隐私等协议`	散客账号登录时必须同意隐私协议
1304	否	string	`账号或密码错误`	登录时提供的账号或密码不正确
1306	否	string	`用户未启用或已过期`	用户状态不是启用状态，或用户有效期已过（适用于系统用户和客户端用户）
1401	否	string	`用户不存在`	指定的用户记录在系统中不存在（适用于系统用户和客户端用户）
1403	否	string	`不支持当前系统, 可联系管理员处理`	当前账号不支持访问该系统，需要联系管理员处理
1500	否	string	`接口标识不能为空 / 缺少会员密钥 / 会员密钥无效`	请求中缺少会员密钥，或会员密钥格式错误、无法解析
1501	否	string	`接口未授权或未在系统中配置 / 激活已超时，请重新绑定激活`	接口未授权或未在系统中配置，或激活操作已超时需要重新绑定
1502	否	string	`缺少必要权限`	账号缺少访问资源所需的权限
1504	否	string	`您绑定的会员码无效`	绑定的会员码不存在、状态无效、会员类型无效或已过期
1505	否	string	`传入的会员需要重新绑定`	会员密钥已过期，需要重新绑定激活
1508	否	string	`当前会员不支持当前功能`	会员未开通请求的功能模块
1509	否	string	`缺少功能代码`	请求中缺少必要的功能代码参数
1999	否	string	`权限校验失败`	权限校验过程中发生未预期的错误
400	否	string	`请求参数错误 / 参数验证失败`	请求参数格式错误或验证失败
401	否	string	`未授权访问 / 令牌无效 / 令牌已过期 / 登录失败,用户名或密码错误`	未授权访问，令牌无效或已过期，或登录凭据错误
403	否	string	`禁止访问`	账号没有权限访问该资源
404	否	string	`资源不存在`	请求的资源在系统中不存在
405	否	string	`此接口仅支持 POST 方法，请使用 POST 请求`	请求方法不正确，该接口仅支持POST方法
409	否	string	`资源冲突 / 数据已存在`	创建的资源已存在，或数据冲突
429	否	string	`请求过于频繁，请稍后再试`	请求频率超过限制，需要稍后重试
500	否	string	`操作失败 / 服务器内部错误 / 数据库操作失败`	服务器内部错误，操作失败或数据库操作异常

资源管理

模块标识: resource | 接口数量: 6

GET 查询所有有效资源 `/api/resources/active`

查看详情

查询所有有效的资源配置列表，用于其他业务通过选择列表选择目标资源。返回所有 status = 1 的资源，不需要分页。支持通过 systemId 查询指定系统的资源。支持通过 X-Site header 切换站点，切换后查询对应站点的数据库。

请求参数

参数名	必填	类型	示例	说明
systemId	否	string	-	所属系统ID，用于过滤资源所属系统。不传则返回所有系统的有效资源
moduleId	否	string	-	关联模块ID（可选）。传入时需与 systemId 搭配，用于按模块过滤资源

响应示例

{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": [
      {
        "id": 1,
        "code": "RES0001",
        "name": "用户列表",
        "title": "用户列表",
        "systemId": "系统ID",
        "systemName": "权限管理系统",
        "type": "page",
        "url": "/users",
        "status": 1,
        "parentId": null,
        "moduleId": "AUTH_USER",
        "orderNum": 1,
        "createTime": "2025-01-01T10:00:00.000Z"
      },
      {
        "id": 2,
        "code": "RES0002",
        "name": "角色管理",
        "title": "角色管理",
        "systemId": "系统ID",
        "systemName": "权限管理系统",
        "type": "page",
        "url": "/roles",
        "status": 1,
        "parentId": null,
        "moduleId": "AUTH_ROLE",
        "orderNum": 2,
        "createTime": "2025-01-01T11:00:00.000Z"
      }
    ]
  }
}

注意事项

仅返回 status = 1 的有效资源
按 orderNum 和 createTime 排序
不需要分页，返回完整列表
支持通过 systemId 查询参数过滤指定系统的资源
支持通过 moduleId 查询参数过滤指定模块资源（需同时传 systemId）
也支持通过路径参数 systemId 查询（如 /api/security/systems/{systemId}/resources/active）

GET 获取资源列表 `/api/resources`

查看详情

分页获取资源列表，支持按名称、类型、系统筛选。支持通过 X-Site header 切换站点，切换后查询对应站点的数据库。

请求参数

参数名	必填	类型	示例	说明
pageNum	否	number	-	页码，默认1
pageSize	否	number	-	每页数量，默认10
name	否	string	-	资源名称关键词
code	否	string	-	资源编码
type	否	string	-	资源类型
systemId	否	string	-	所属系统ID，用于过滤资源所属系统
moduleId	否	string	-	关联模块ID（可选）。传入时需与 systemId 搭配，用于按模块过滤资源

响应示例

{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "list": [
        {
          "id": 1,
          "code": "RES0001",
          "name": "用户列表",
          "systemId": "AUTH",
          "systemName": "权限管理系统",
          "type": "page",
          "url": "/users",
          "status": 1,
          "parentId": null,
          "moduleId": "AUTH_USER",
          "orderNum": 10
        }
      ],
      "total": 100,
      "pageNum": 1,
      "pageSize": 10
    }
  }
}

注意事项

列表结果固定按 orderNum 升序，其次按 createTime 倒序
orderNum 越小，菜单同级显示越靠前

GET 获取资源详情 `/api/resources/{id}`

查看详情

根据资源ID获取资源详细信息

请求参数

参数名	必填	类型	示例	说明
id	是	string	-	资源ID

响应示例

{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "id": 1,
      "code": "RES0001",
      "name": "用户列表",
      "systemId": "AUTH",
      "systemName": "权限管理系统",
      "type": "page",
      "url": "/users",
      "status": 1,
      "parentId": null,
      "moduleId": "AUTH_USER",
      "orderNum": 10
    }
  },
  "failure": {
    "code": "4040",
    "message": "资源不存在",
    "data": null
  }
}

POST 创建资源 `/api/resources`

查看详情

创建新的资源

请求参数

请求体

{
  "name": "string｜必填，资源名称",
  "systemId": "string｜必填，所属系统ID，用于绑定资源所属系统",
  "type": "string｜必填，资源类型，例如page/api/button",
  "url": "string｜必填，资源URL，用于路由或接口地址",
  "status": "number｜可选，状态：1-启用，0-禁用",
  "parentId": "string｜可选，父级资源ID，用于构建资源树状结构，不传或传空则为根节点",
  "moduleId": "string｜可选，关联模块ID，可为空（推荐与systemId保持一致）",
  "orderNum": "number｜可选，排序序号（同级内升序），默认0"
}

请按照示例结构封装请求体字段，并确保必填字段完整。

响应示例

{
  "success": {
    "code": "0000",
    "message": "创建资源成功",
    "data": {
      "id": 1,
      "code": "RES0001",
      "name": "用户列表",
      "systemId": "AUTH",
      "systemName": "权限管理系统",
      "type": "page",
      "url": "/users",
      "status": 1,
      "parentId": null,
      "moduleId": "AUTH_USER",
      "orderNum": 10
    }
  },
  "failure": {
    "code": "4000",
    "message": "创建资源失败",
    "data": null
  }
}

注意事项

code 由系统自动生成，无需传入
moduleId 可为空；若传入，需为该 systemId 下有效模块
orderNum 用于菜单树同级排序，值越小越靠前

PUT 更新资源 `/api/resources/{id}`

查看详情

更新指定资源的信息

请求参数

参数名	必填	类型	示例	说明
id	是	string	-	资源ID

请求体

{
  "name": "string｜必填，资源名称",
  "systemId": "string｜可选，所属系统ID，不传则保持原值",
  "type": "string｜必填，资源类型，例如page/api/button",
  "url": "string｜必填，资源URL，用于路由或接口地址",
  "status": "number｜可选，状态：1-启用，0-禁用",
  "parentId": "string｜可选，父级资源ID，用于构建资源树状结构，不传或传空则为根节点",
  "moduleId": "string｜可选，关联模块ID；传空字符串或null可清空关联",
  "orderNum": "number｜可选，排序序号（同级内升序），不传则保持原值"
}

请按照示例结构封装请求体字段，并确保必填字段完整。

响应示例

{
  "success": {
    "code": "0000",
    "message": "更新资源成功",
    "data": {
      "id": 1,
      "code": "RES0001",
      "name": "用户列表",
      "systemId": "AUTH",
      "systemName": "权限管理系统",
      "type": "page",
      "url": "/users",
      "status": 1,
      "parentId": null,
      "moduleId": "AUTH_USER",
      "orderNum": 20
    }
  },
  "failure": {
    "code": "4000",
    "message": "更新资源失败",
    "data": null
  }
}

注意事项

moduleId 为可选字段，可配置/修改/清空模块关联
更新 orderNum 后，菜单树同级排序会按新序号生效

DELETE 删除资源 `/api/resources/{id}`

查看详情

删除指定的资源

请求参数

参数名	必填	类型	示例	说明
id	是	string	-	资源ID

响应示例

{
  "success": {
    "code": "0000",
    "message": "删除资源成功",
    "data": {
      "result": true
    }
  },
  "failure": {
    "code": "4000",
    "message": "删除资源失败",
    "data": null
  }
}

公共请求头（所有接口适用）

API响应码列表

成功响应码 (1个)

错误响应码 (44个)

资源管理

GET 查询所有有效资源 /api/resources/active

GET 获取资源列表 /api/resources

GET 获取资源详情 /api/resources/{id}

POST 创建资源 /api/resources

请求体

PUT 更新资源 /api/resources/{id}

请求体

DELETE 删除资源 /api/resources/{id}

GET 查询所有有效资源 `/api/resources/active`

GET 获取资源列表 `/api/resources`

GET 获取资源详情 `/api/resources/{id}`

POST 创建资源 `/api/resources`

PUT 更新资源 `/api/resources/{id}`

DELETE 删除资源 `/api/resources/{id}`