跳转至

部门(DepartmentController)

提供 KMS 知识管理模块「部门域」的能力:查询当前用户所属企业域下的部门列表。本控制器仅 1 个端点,所有端点均返回 JSON 资源。

  • 接口类型:REST 资源(@RestController,方法级 produces = MediaType.APPLICATION_JSON_VALUE;类级 @RequestMapping 仅声明前缀,未带 produces
  • 基址${myapps.context-path.kms:}/api/kms(类级 @RequestMapping 仅声明单一前缀,/kms 备用前缀;Bean 名 kms-department-controller
  • Tag:kms部门模块

公共说明

  • 鉴权(据源码 KmsMvcConfig + KmsSecurityFilterKmsMvcConfig 注册全局 Servlet 过滤器 KmsSecurityFilter(URL 模式 /*,context-path 为 / 时为 /kms/*)。本控制器路径 /api/kms/departments 不在 KmsSecurityFilter.isExcludeURI 的豁免名单内(豁免仅覆盖 /login.*/admin/domain.*/tray/service/authtimeservice/OfficeServer.*outsideshare/.*/preview、静态资源后缀、actuator/health 等)。过滤器调用 Security.getUserIdFromToken(request),取不到用户则返回 HTTP 401因此所有端点均需 accessToken,可通过以下任一方式传递(据 Security.getUserIdFromToken):query 参数 accessToken、query 参数 access_token(移动端)、请求头 accessToken、Cookie accessToken、请求头 Authorization: Bearer <token>。完整鉴权机制见 index.md「鉴权说明」。
  • 执行用户:控制器内 getUser()(继承自 AbstractBaseController)调用 Security.getUserIdFromToken(request) 还原当前用户 id,再经 Feign(UserAPI.getUserById)装载 KmsUser,并取其 domainid 限定查询范围。userCode 参数
  • 响应结构:统一 Resource(见 ../index.md「统一响应结构」),字段为 errcode/errmsg/data/errors。KMS 的 ResourceAbstractBaseController 内部类,其构造器对 data 执行 ESAPI.encode(data) 做 XSS 编码,故 data 中的 HTML 特殊字符会被转义。
  • HTTP 状态码与错误码(据源码 AbstractBaseController 全局异常处理):成功默认 HTTP 200;InvalidRequestException → HTTP 400 / errcode=400;UnauthorizedException → HTTP 403 / errcode=403;ForbiddenException → HTTP 403 / errcode=403;ResourceNotFoundException → HTTP 404 / errcode=404;其他 Exception → HTTP 500 / errcode=500。
  • @RequestParam 默认必填:未标 required=false 且无 defaultValue 的 query 参数按 Spring 约定为必填。

1. 获取部门列表

查询当前用户所属企业域下的全部部门列表。注意:方法内显式判断 getUser() 返回 null 时抛 UnauthorizedException("无权访问,请先登录系统")(HTTP 403);正常情况下 getUser() 在用户为空时会先抛同样的 UnauthorizedException,故该显式判断为防御性代码。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/departments(完整:{kms-context}/api/kms/departments
  • 鉴权:是(需 accessToken,据源码)
  • Tag:kms部门模块

请求参数

无。

请求示例

GET /api/kms/departments?accessToken=__TOKEN__ HTTP/1.1

响应

结构:统一 ResourcedataList<Department>,部门列表(由 service.listDepartmentsByDomainId(user.getDomainid()) 返回)。

失败示例(用户未登录,getUser() 返回 null 时显式抛异常)

{ "errcode": 403, "errmsg": "无权访问,请先登录系统", "data": null, "errors": null }