diff --git a/src/main/java/com/muyu/auth/controller/TokenController.java b/src/main/java/com/muyu/auth/controller/TokenController.java index d870762..ed6a5a3 100644 --- a/src/main/java/com/muyu/auth/controller/TokenController.java +++ b/src/main/java/com/muyu/auth/controller/TokenController.java @@ -1,7 +1,9 @@ package com.muyu.auth.controller; -import com.muyu.auth.form.LoginBody; -import com.muyu.auth.form.RegisterBody; +import cn.hutool.core.convert.Convert; +import com.muyu.auth.domian.LoginUserReq; +import com.muyu.auth.domian.RegisterBody; +import com.muyu.auth.domian.TokenResp; import com.muyu.auth.service.SysLoginService; import com.muyu.common.core.domain.Result; import com.muyu.common.core.utils.JwtUtils; @@ -10,13 +12,16 @@ import com.muyu.common.security.auth.AuthUtil; import com.muyu.common.security.service.TokenService; import com.muyu.common.security.utils.SecurityUtils; import com.muyu.common.system.domain.LoginUser; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; +import jakarta.servlet.http.HttpServletRequest; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; -import jakarta.servlet.http.HttpServletRequest; +import java.util.Map; /** * token 控制 @@ -24,6 +29,7 @@ import jakarta.servlet.http.HttpServletRequest; * @author muyu */ @RestController +@Tag(name = "鉴权接口",description = "鉴权相关控制层") public class TokenController { @Autowired private TokenService tokenService; @@ -32,14 +38,25 @@ public class TokenController { private SysLoginService sysLoginService; @PostMapping("login") - public Result login (@RequestBody LoginBody form) { + @Operation(summary = "登录接口",description = "登录鉴权接口") + public Result login (@RequestBody LoginUserReq form) { // 用户登录 LoginUser userInfo = sysLoginService.login(form.getUsername(), form.getPassword()); // 获取登录token - return Result.success(tokenService.createToken(userInfo)); + Map tokenMap = tokenService.createToken(userInfo); + + return Result.success( + TokenResp.builder() + .accessToken(Convert.toStr(tokenMap.get("access_token"))) + .expiresIn(Convert.toLong(tokenMap.get("expires_in"))) + .build() + + + ); } @DeleteMapping("logout") + @Operation(summary = "注销接口",description = "用户注销接口") public Result logout (HttpServletRequest request) { String token = SecurityUtils.getToken(request); if (StringUtils.isNotEmpty(token)) { @@ -53,6 +70,7 @@ public class TokenController { } @PostMapping("refresh") + @Operation(summary = "用户登录时间刷新",description = "用户登录时间刷新接口,可以进行用户token续约") public Result refresh (HttpServletRequest request) { LoginUser loginUser = tokenService.getLoginUser(request); if (StringUtils.isNotNull(loginUser)) { diff --git a/src/main/java/com/muyu/auth/domian/LoginUserReq.java b/src/main/java/com/muyu/auth/domian/LoginUserReq.java new file mode 100644 index 0000000..0ee98e6 --- /dev/null +++ b/src/main/java/com/muyu/auth/domian/LoginUserReq.java @@ -0,0 +1,43 @@ +package com.muyu.auth.domian; + +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * 用户登录对象 + * + * @author muyu + */ +@Data +@Builder +@AllArgsConstructor +@NoArgsConstructor +@Tag(name = "登录请求实体类") +public class LoginUserReq { + /** + * 用户名 + */ + @Schema( + title = "用户名称", + type = "String", + defaultValue = "admin", + description = "登录用户名称" + ) + private String username; + + /** + * 用户密码 + */ + @Schema( + title = "用户密码", + type = "String", + defaultValue = "admin123", + description = "登录用户密码" + ) + private String password; + +} diff --git a/src/main/java/com/muyu/auth/domian/RegisterBody.java b/src/main/java/com/muyu/auth/domian/RegisterBody.java new file mode 100644 index 0000000..861c2aa --- /dev/null +++ b/src/main/java/com/muyu/auth/domian/RegisterBody.java @@ -0,0 +1,10 @@ +package com.muyu.auth.domian; + +/** + * 用户注册对象 + * + * @author muyu + */ +public class RegisterBody extends LoginUserReq { + +} diff --git a/src/main/java/com/muyu/auth/domian/TokenResp.java b/src/main/java/com/muyu/auth/domian/TokenResp.java new file mode 100644 index 0000000..47e0540 --- /dev/null +++ b/src/main/java/com/muyu/auth/domian/TokenResp.java @@ -0,0 +1,49 @@ +package com.muyu.auth.domian; + +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * @Author：zhangchengzhi + * @Package：com.muyu.auth.domian + * @Project：cloud-auth + * @name：TokenResp + * @Date：2024/8/7 15:55 + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +@Tag(name = "token响应结果集",description = "包含token和token有效时间") +public class TokenResp { + + /** + * token令牌 + */ + + @Schema( + title = "token令牌", + type = "String", + defaultValue = "eyj0e.eyj1dlLTj9.Pk5KS_Uh2n", + description = "JWT令牌,包含头,载体,尾" + ) + private String accessToken; + + + /** + * 有效时间 + */ + @Schema( + title = "令牌有效时间/MIN", + type = "Long", + defaultValue = "720", + description = "过期时间,时间单位为分钟(MIN)" + ) + private Long expiresIn; + + +} diff --git a/src/main/java/com/muyu/auth/form/LoginBody.java b/src/main/java/com/muyu/auth/form/LoginBody.java deleted file mode 100644 index 999ad44..0000000 --- a/src/main/java/com/muyu/auth/form/LoginBody.java +++ /dev/null @@ -1,34 +0,0 @@ -package com.muyu.auth.form; - -/** - * 用户登录对象 - * - * @author muyu - */ -public class LoginBody { - /** - * 用户名 - */ - private String username; - - /** - * 用户密码 - */ - private String password; - - public String getUsername () { - return username; - } - - public void setUsername (String username) { - this.username = username; - } - - public String getPassword () { - return password; - } - - public void setPassword (String password) { - this.password = password; - } -} diff --git a/src/main/java/com/muyu/auth/form/RegisterBody.java b/src/main/java/com/muyu/auth/form/RegisterBody.java deleted file mode 100644 index c2a4d5a..0000000 --- a/src/main/java/com/muyu/auth/form/RegisterBody.java +++ /dev/null @@ -1,10 +0,0 @@ -package com.muyu.auth.form; - -/** - * 用户注册对象 - * - * @author muyu - */ -public class RegisterBody extends LoginBody { - -}