swagger备注

user-service/src/main/java/com/diagbot/facade/UserFacade.java

@@ -86,7 +86,7 @@ public class UserFacade extends UserServiceImpl {
     }
 
 
-    public RespDTO resetPassword(String username, String password) {
+    public RespDTO resetPassword(String username, String password, String diffPassword) {
         if (StringUtil.isBlank(username)){
             throw new CommonException(CommonErrorCode.PARAM_IS_NULL,
                     "请输入手机号!");
@@ -100,6 +100,11 @@ public class UserFacade extends UserServiceImpl {
             throw new CommonException(ServiceErrorCode.USER_NOT_FOUND);
         }
         PasswordEncoder passwordEncoder = PasswordEncoderFactories.createDelegatingPasswordEncoder();
+        if(!StringUtil.isBlank(diffPassword) && "Y".equals(diffPassword)) {
+            if(passwordEncoder.matches(password,user.getPassword())){
+                throw new CommonException(CommonErrorCode.PARAM_IS_ERROR, "修改后密码不能与修改前相同!");
+            }
+        }
         String entryPassword= passwordEncoder.encode(password);
         user.setPassword(entryPassword);
         user.setGmtModified(new Date());

user-service/src/main/java/com/diagbot/web/UserController.java

@@ -2,6 +2,7 @@ package com.diagbot.web;
 
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import com.diagbot.annotation.SysLogger;
+import com.diagbot.dto.LoginDTO;
 import com.diagbot.dto.RespDTO;
 import com.diagbot.entity.User;
 import com.diagbot.facade.UserFacade;
@@ -31,29 +32,41 @@ public class UserController {
     @Autowired
     private UserFacade userFacade;
 
-    @ApiOperation(value = "注册", notes = "username|password|organization|email|linkman|imgId|code为必填项")
+    @ApiOperation(value = "注册",
+        notes = "username：用户名，必填<br>" +
+                "password：密码，必填<br> " +
+                "organization：组织机构，必填<br>" +
+                "email：邮箱，必填<br>" +
+                "linkman：联系人，必填<br>" +
+                "imgId：图片id，必填<br>" +
+                "code：图片验证码，必填<br>")
     @PostMapping("/registry")
     @SysLogger("registry")
     @Transactional
-    public RespDTO createUser(@RequestBody UserSaveVO userSaveVO){
+    public RespDTO<User> createUser(@RequestBody UserSaveVO userSaveVO){
         User user = userFacade.createUser(userSaveVO);
         return RespDTO.onSuc(user);
     }
 
 
-    @ApiOperation(value = "登录", notes = "username|password为必选项")
+    @ApiOperation(value = "登录",
+            notes = "username：用户名,必填<br>" +
+                    "password：密码, 必填<br> ")
     @PostMapping("/login")
     @SysLogger("login")
-    public RespDTO login(@RequestParam String username, @RequestParam String password){
+    public RespDTO<LoginDTO> login(@RequestParam String username, @RequestParam String password){
         return  userFacade.login(username, password);
     }
 
 
-    @ApiOperation(value = "重置密码", notes = "username|password为必选项")
+    @ApiOperation(value = "重置密码",
+            notes = "username：用户名,必填<br>" +
+                    "password：密码, 必填<br> " +
+                    "diffPassword：值为Y，表示修改前和修改后密码不相同<br>")
     @PostMapping("/resetPassword")
     @SysLogger("resetPassword")
-    public RespDTO resetPassword(String username, String password){
-        return  userFacade.resetPassword(username, password);
+    public RespDTO<Boolean> resetPassword(String username, String password, String diffPassword){
+        return  userFacade.resetPassword(username, password, diffPassword);
     }
 
 

user-service/src/main/java/com/diagbot/web/VerController.java

@@ -1,6 +1,7 @@
 package com.diagbot.web;
 
 import com.diagbot.annotation.SysLogger;
+import com.diagbot.dto.ImgVerCreatDTO;
 import com.diagbot.dto.RespDTO;
 import com.diagbot.facade.VerFacade;
 import com.diagbot.vo.ImgVerVerVO;
@@ -33,7 +34,7 @@ public class VerController {
     @ApiOperation(value = "获取图片验证码", notes = "获取图片验证码包括图片验证码唯一标志和图片信息")
     @PostMapping("/getImgVerification")
     @SysLogger("getImgVerification")
-    public RespDTO getImgVerification(){
+    public RespDTO<ImgVerCreatDTO> getImgVerification(){
         return   RespDTO.onSuc(verFacade.getImgVerification());
     }
 
@@ -42,10 +43,12 @@ public class VerController {
      * @param imgVerVerVO 验证图片验证码所需参数
      * @return 是否验证成功
      */
-    @ApiOperation(value = "验证图片验证码", notes = "图片验证码唯一标志后和验证码不能为空")
+    @ApiOperation(value = "验证图片验证码",
+            notes = "imgId：图片id<br>" +
+                    "code：图片验证码<br>")
     @PostMapping("/verifyImgVerification")
     @SysLogger("verifyImgVerification")
-    public RespDTO verImgVerification(@RequestBody @Valid ImgVerVerVO imgVerVerVO){
+    public RespDTO<Boolean> verImgVerification(@RequestBody @Valid ImgVerVerVO imgVerVerVO){
         return  RespDTO.onSuc(verFacade.verifyImgVerification(imgVerVerVO));
     }
 
@@ -54,22 +57,28 @@ public class VerController {
      * @param smsVerCreatVO 获取短信验证码输入参数
      * @return 获取短信验证码是否成功
      */
-    @ApiOperation(value = "注册获取短信验证码", notes = "图片验证码唯一标志后，图形验证码，用户号码不能为空")
+    @ApiOperation(value = "注册获取短信验证码",
+            notes = "mobile：手机号，必填<br>" +
+                    "imgId：图片id<br>" +
+                    "code：图片验证码<br>")
     @PostMapping("/getSmsWithRegister")
     @SysLogger("getSmsWithRegister")
-    public RespDTO getSmsWithRegister(@RequestBody @Valid SmsVerCreatVO smsVerCreatVO){
+    public RespDTO<Boolean> getSmsWithRegister(@RequestBody @Valid SmsVerCreatVO smsVerCreatVO){
         return   RespDTO.onSuc(verFacade.getSmsVerification(smsVerCreatVO));
     }
 
+
     /**
      * 验证注册短信码并且注册为新的用户
      * @param smsVerVerVO 短信验证码验证输入信息
      * @return 用户信息是否注册到数据库
      */
-    @ApiOperation(value = "验证短信验证码", notes = "用户号码，用户验证码不能为空")
+    @ApiOperation(value = "验证短信验证码",
+            notes = "mobile：手机号，必填<br>" +
+                    "smsCode：短信验证码，必填<br>")
     @PostMapping("/verifySmsVerification")
     @SysLogger("verifySmsVerification")
-    public RespDTO verifySmsVerification(@RequestBody SmsVerVerVO smsVerVerVO){
+    public RespDTO<Boolean> verifySmsVerification(@RequestBody SmsVerVerVO smsVerVerVO){
         return RespDTO.onSuc(verFacade.verifySmsVerification(smsVerVerVO));
     }
 
@@ -79,10 +88,13 @@ public class VerController {
      * @param smsVerCreatVO 获取短信验证码输入参数
      * @return 获取短信验证码是否成功
      */
-    @ApiOperation(value = "忘记密码获取短信验证码", notes = "用户号码不能为空")
+    @ApiOperation(value = "忘记密码获取短信验证码",
+            notes = "mobile：手机号，必填<br>" +
+                    "imgId：图片id<br>" +
+                    "code：图片验证码<br>")
     @PostMapping("/getSmsWithResetPassword")
     @SysLogger("getSmsWithResetPassword")
-    public RespDTO getSmsWithResetPassword(@RequestBody @Valid SmsVerCreatVO smsVerCreatVO){
+    public RespDTO<Boolean> getSmsWithResetPassword(@RequestBody @Valid SmsVerCreatVO smsVerCreatVO){
         return   RespDTO.onSuc(verFacade.getSmsWithResetPassword(smsVerCreatVO));
     }