← 返回首页

API模块详情

当前查看模块：securitySystem

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

参数名 必填 类型 示例 说明
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）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。

安全系统管理

模块标识: securitySystem | 接口数量: 2

GET 查询所有有效系统 /api/security/systems/active

查看详情
查询所有有效的系统配置列表，用于其他业务通过选择列表选择目标系统。返回所有 status = 1 的系统，不需要分页
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数

暂无请求参数定义

响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": [
      {
        "id": 1,
        "code": "AUTH",
        "name": "权限管理系统",
        "status": 1,
        "description": "权限管理系统描述",
        "createTime": "2025-01-01T10:00:00.000Z",
        "updateTime": "2025-01-01T10:00:00.000Z"
      },
      {
        "id": 2,
        "code": "ORDER",
        "name": "订单管理系统",
        "status": 1,
        "description": "订单管理系统描述",
        "createTime": "2025-01-01T11:00:00.000Z",
        "updateTime": "2025-01-01T11:00:00.000Z"
      }
    ]
  }
}
注意事项
  • 仅返回 status = 1 的有效系统
  • 按创建时间倒序排列
  • 不需要分页，返回完整列表

GET 查询某个系统下的有效模块 /api/security/systems/{systemId}/modules/active

查看详情
查询指定系统下所有有效的模块列表，用于其他业务通过选择列表选择目标模块。返回所有 status = 1 的模块，不需要分页
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
systemId 是 string - 系统ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": [
      {
        "id": 1,
        "code": "AUTH_USER",
        "name": "用户管理模块",
        "systemId": "系统ID",
        "systemName": "权限管理系统",
        "status": 1,
        "description": "用户管理模块描述",
        "createTime": "2025-01-01T10:00:00.000Z",
        "updateTime": "2025-01-01T10:00:00.000Z"
      },
      {
        "id": 2,
        "code": "AUTH_ROLE",
        "name": "角色管理模块",
        "systemId": "系统ID",
        "systemName": "权限管理系统",
        "status": 1,
        "description": "角色管理模块描述",
        "createTime": "2025-01-01T11:00:00.000Z",
        "updateTime": "2025-01-01T11:00:00.000Z"
      }
    ]
  },
  "failure": {
    "code": "4040",
    "message": "系统不存在",
    "data": null
  }
}
注意事项
  • 仅返回指定系统下 status = 1 的有效模块
  • 按创建时间倒序排列
  • 不需要分页，返回完整列表
  • 如果系统不存在，返回404错误