程序包 com.elitesland.ystdms.sys.feign

接口 JwtAuthClient

所有超级接口:

JwtAuthApi

@FeignClient(name="${yst.service.system:yst-dms2-newsys}",
             path="/api/v1/jwt",
             primary=false)
public interface JwtAuthClient
extends JwtAuthApi

JWT认证Feign客户端 其他业务域通过Feign调用newsyc-core获取JWT服务

嵌套类概要

从接口继承的嵌套类/接口 com.elitesland.ystdms.sys.api.JwtAuthApi

JwtAuthApi.UserInfoResponse

方法概要

修饰符和类型	方法	说明
ApiResult<String>	generateJwtByUserId(UUID userId)	根据用户主键签发对外访问 JWT 字符串（规则与 JwtAuthApi.generateJwtByUsername(String) 一致，不含密码校验）。
ApiResult<String>	generateJwtByUsername(String username)	根据登录账号签发对外访问 JWT 字符串（规则与登录成功后的 accessToken 一致，不含密码校验）。
ApiResult<JwtTokenResponse>	generateToken(JwtTokenRequest request)	生成JWT令牌
ApiResult<JwtTokenResponse>	generateTokenForCurrentUser(Integer expiration)	基于当前登录用户上下文生成 HS256（对称密钥）JWT
ApiResult<JwtAuthApi.UserInfoResponse>	getCurrentUser()	获取当前登录用户信息
ApiResult<Boolean>	hasPermission(String permission)	检查当前用户权限
ApiResult<JwtValidationResponse>	parseToken(JwtValidationRequest request)	解析JWT令牌
ApiResult<JwtTokenResponse>	refreshToken(JwtValidationRequest request)	刷新JWT令牌
ApiResult<JwtValidationResponse>	validateToken(JwtValidationRequest request)	验证JWT令牌

方法详细资料

generateToken

@PostMapping("/generate")
ApiResult<JwtTokenResponse> generateToken(@RequestBody
 JwtTokenRequest request)

从接口复制的说明: JwtAuthApi

生成JWT令牌

指定者:

generateToken 在接口中 JwtAuthApi

参数:

request - 令牌生成请求

返回:

令牌响应

generateTokenForCurrentUser

@PostMapping("/generate/current")
ApiResult<JwtTokenResponse> generateTokenForCurrentUser(@RequestParam(value="expiration",required=false)
 Integer expiration)

从接口复制的说明: JwtAuthApi

基于当前登录用户上下文生成 HS256（对称密钥）JWT

指定者:

generateTokenForCurrentUser 在接口中 JwtAuthApi

参数:

expiration - 过期时间（秒），可选；不传则使用默认配置

返回:

令牌响应

generateJwtByUsername

@PostMapping("/generate/by-username")
ApiResult<String> generateJwtByUsername(@RequestParam("username")
 String username)

从接口复制的说明: JwtAuthApi

根据登录账号签发对外访问 JWT 字符串（规则与登录成功后的 accessToken 一致，不含密码校验）。 仅限受信任的服务间调用，请配合网络与权限控制使用。

指定者:

generateJwtByUsername 在接口中 JwtAuthApi

参数:

username - 登录账号

返回:

JWT 字符串

generateJwtByUserId

@PostMapping("/generate/by-user-id")
ApiResult<String> generateJwtByUserId(@RequestParam("userId")
 UUID userId)

从接口复制的说明: JwtAuthApi

根据用户主键签发对外访问 JWT 字符串（规则与 JwtAuthApi.generateJwtByUsername(String) 一致，不含密码校验）。 仅限受信任的服务间调用，请配合网络与权限控制使用。

指定者:

generateJwtByUserId 在接口中 JwtAuthApi

参数:

userId - 用户主键

返回:

JWT 字符串

validateToken

@PostMapping("/validate")
ApiResult<JwtValidationResponse> validateToken(@RequestBody
 JwtValidationRequest request)

从接口复制的说明: JwtAuthApi

验证JWT令牌

指定者:

validateToken 在接口中 JwtAuthApi

参数:

request - 验证请求

返回:

验证响应

parseToken

@PostMapping("/parse")
ApiResult<JwtValidationResponse> parseToken(@RequestBody
 JwtValidationRequest request)

从接口复制的说明: JwtAuthApi

解析JWT令牌

指定者:

parseToken 在接口中 JwtAuthApi

参数:

request - 解析请求

返回:

解析响应

refreshToken

@PostMapping("/refresh")
ApiResult<JwtTokenResponse> refreshToken(@RequestBody
 JwtValidationRequest request)

从接口复制的说明: JwtAuthApi

刷新JWT令牌

指定者:

refreshToken 在接口中 JwtAuthApi

参数:

request - 包含原token的请求

返回:

新的令牌

getCurrentUser

@GetMapping("/user/current")
ApiResult<JwtAuthApi.UserInfoResponse> getCurrentUser()

从接口复制的说明: JwtAuthApi

获取当前登录用户信息

指定者:

getCurrentUser 在接口中 JwtAuthApi

返回:

当前用户信息

hasPermission

@GetMapping("/user/permission")
ApiResult<Boolean> hasPermission(@RequestParam("permission")
 String permission)

从接口复制的说明: JwtAuthApi

检查当前用户权限

指定者:

hasPermission 在接口中 JwtAuthApi

参数:

permission - 权限标识

返回:

是否拥有权限