KMS 欢迎页(KmsWelcomeController)¶
提供 KMS 知识管理模块「欢迎域」的能力:服务健康检查。本控制器共 1 个端点,响应非统一 Resource,直接返回 Map<String, String>。
- 接口类型:REST 资源(
@RestController,类级@Scope("prototype")) - 基址:
${myapps.context-path.kms:}(类级@RequestMapping仅声明 context-path 根前缀,端点路径不再带/api子段) - Tag:欢迎(类级
@Tag(name = "欢迎"))
公共说明¶
- 鉴权(据源码
KmsMvcConfig+KmsSecurityFilter):KmsMvcConfig注册全局 Servlet 过滤器KmsSecurityFilter(URL 模式/*,context-path 为/时为/kms/*)。本控制器路径/health不在KmsSecurityFilter.isExcludeURI的豁免名单内——豁免名单中的健康检查正则为^.*actuator/health$,仅匹配含actuator/health段的 URI,不**匹配单纯的/health。过滤器调用Security.getUserIdFromToken(request),取不到用户则返回 HTTP401。**因此本端点需 accessToken,可通过以下任一方式传递:query 参数accessToken、query 参数access_token(移动端)、请求头accessToken、CookieaccessToken、请求头Authorization: Bearer <token>。完整鉴权机制见 index.md「鉴权说明」。 - 类继承(据源码):本控制器**不**继承
AbstractBaseController,因此不享其Resource包装器与全局异常处理器;端点直接返回ResponseEntity<Map<String, String>>,无errcode/errmsg字段。 - 响应结构:非统一
Resource。HTTP 200,body 为Map<String, String>,固定两键status、service。
1. 健康检查¶
返回 KMS 服务运行状态(据 Javadoc「健康检查接口」)。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/health(完整:{kms-context}/health) - 鉴权:是(需 accessToken,据源码;与 actuator 健康检查
actuator/health不同,不在豁免名单内) - Tag:欢迎
请求参数¶
无。
请求示例¶
响应¶
结构:非统一 Resource。HTTP 200,body 为 Map<String, String>,固定字段:
| 字段 | 类型 | 说明 |
|---|---|---|
| status | string | 服务状态,固定 "UP" |
| service | string | 服务名,固定 "OBPM KMS" |
成功示例:
注:与 Spring Boot Actuator 的
/actuator/health(在KmsSecurityFilter豁免名单内)不同,本端点路径仅为/health,仍需 accessToken。