跳转至

KMS 欢迎页(KmsWelcomeController)

提供 KMS 知识管理模块「欢迎域」的能力:服务健康检查。本控制器共 1 个端点,响应非统一 Resource,直接返回 Map<String, String>

  • 接口类型:REST 资源(@RestController,类级 @Scope("prototype")
  • 基址${myapps.context-path.kms:}(类级 @RequestMapping 仅声明 context-path 根前缀,端点路径不再带 /api 子段)
  • Tag:欢迎(类级 @Tag(name = "欢迎")

公共说明

  • 鉴权(据源码 KmsMvcConfig + KmsSecurityFilterKmsMvcConfig 注册全局 Servlet 过滤器 KmsSecurityFilter(URL 模式 /*,context-path 为 / 时为 /kms/*)。本控制器路径 /health 不在 KmsSecurityFilter.isExcludeURI 的豁免名单内——豁免名单中的健康检查正则为 ^.*actuator/health$,仅匹配含 actuator/health 段的 URI,不**匹配单纯的 /health。过滤器调用 Security.getUserIdFromToken(request),取不到用户则返回 HTTP 401。**因此本端点需 accessToken,可通过以下任一方式传递:query 参数 accessToken、query 参数 access_token(移动端)、请求头 accessToken、Cookie accessToken、请求头 Authorization: Bearer <token>。完整鉴权机制见 index.md「鉴权说明」。
  • 类继承(据源码):本控制器**不**继承 AbstractBaseController,因此不享其 Resource 包装器与全局异常处理器;端点直接返回 ResponseEntity<Map<String, String>>,无 errcode/errmsg 字段。
  • 响应结构非统一 Resource。HTTP 200,body 为 Map<String, String>,固定两键 statusservice

1. 健康检查

返回 KMS 服务运行状态(据 Javadoc「健康检查接口」)。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/health(完整:{kms-context}/health
  • 鉴权:是(需 accessToken,据源码;与 actuator 健康检查 actuator/health 不同,不在豁免名单内)
  • Tag:欢迎

请求参数

无。

请求示例

GET /health?accessToken=__TOKEN__ HTTP/1.1

响应

结构非统一 Resource。HTTP 200,body 为 Map<String, String>,固定字段:

字段 类型 说明
status string 服务状态,固定 "UP"
service string 服务名,固定 "OBPM KMS"

成功示例

{
  "status": "UP",
  "service": "OBPM KMS"
}

注:与 Spring Boot Actuator 的 /actuator/health(在 KmsSecurityFilter 豁免名单内)不同,本端点路径仅为 /health,仍需 accessToken。