接口文档

pom.xml

@@ -109,11 +109,12 @@
             <artifactId>fastjson</artifactId>
             <version>1.2.75</version>
         </dependency>
-        <!-- swagger -->
+        <!-- knife4j：swagger增强-->
+        <!-- https://doc.xiaominfo.com/knife4j/documentation/get_start.html -->
         <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-boot-starter</artifactId>
-            <version>3.0.0</version>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-spring-boot-starter</artifactId>
+            <version>3.0.2</version>
         </dependency>
 
 

src/main/java/com/caimei365/user/UserApplication.java

@@ -11,6 +11,7 @@ import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
  * @author : Charles
  * @date : 2021/2/22
  */
+
 @EnableDiscoveryClient
 @SpringBootApplication
 public class UserApplication {

src/main/java/com/caimei365/user/config/SwaggerConfig.java

@@ -6,15 +6,18 @@ import org.springframework.context.annotation.Configuration;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.oas.annotations.EnableOpenApi;
 import springfox.documentation.service.*;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
 
 /**
- * @author Aslee
+ * `@EnableOpenApi`: 用于开启Swagger的自动配置
  *
+ * @author Aslee
  * @date 2021/3/10
  */
+@EnableOpenApi
 @Configuration
 public class SwaggerConfig {
     @Value(value = "${swagger.enabled}")

src/main/java/com/caimei365/user/controller/BaseApi.java

@@ -2,9 +2,13 @@ package com.caimei365.user.controller;
 
 import com.caimei365.user.model.ResponseJson;
 import com.caimei365.user.service.BaseService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import java.util.Map;
@@ -15,6 +19,7 @@ import java.util.Map;
  * @author : Charles
  * @date : 2021/3/4
  */
+@Api(tags="用户公共API")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/user")
@@ -29,8 +34,11 @@ public class BaseApi {
      *
      * @param platformType 0:www，1:crm/h5，2:小程序
      */
+    @ApiOperation("获取图片验证码")
     @GetMapping("/captcha")
-    public ResponseJson<Map<String, Object>> getCaptchaImage(Integer platformType) {
+    public ResponseJson<Map<String, Object>> getCaptchaImage(
+        @ApiParam(required = true, value = "0:www，1:crm/h5，2:小程序") @RequestParam("platformType") Integer platformType
+    ) {
         return baseService.getCaptchaImage(platformType);
     }
 
@@ -45,8 +53,15 @@ public class BaseApi {
      * @param token            图片验证码token
      * @param platformType     0:www，1:crm/h5，2:小程序
      */
+    @ApiOperation("获取短信验证码")
     @GetMapping("/sms/code")
-    public ResponseJson getSmsCode(String mobile, String activateCodeType, String imgCode, String token, Integer platformType) {
+    public ResponseJson getSmsCode(
+        @ApiParam(required = true, value = "手机号") @RequestParam("mobile") String mobile,
+        String activateCodeType,
+        String imgCode,
+        String token,
+        Integer platformType
+    ) {
         return baseService.getSmsCode(mobile, activateCodeType, imgCode, token, platformType);
     }
 

src/main/java/com/caimei365/user/controller/ClubApi.java

@@ -3,6 +3,7 @@ package com.caimei365.user.controller;
 import com.caimei365.user.model.ResponseJson;
 import com.caimei365.user.model.dto.ClubUpdateDto;
 import com.caimei365.user.service.ClubService;
+import io.swagger.annotations.Api;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -18,6 +19,7 @@ import java.util.Map;
  * @author : Charles
  * @date : 2021/3/4
  */
+@Api(tags="机构用户API")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/user/club")

src/main/java/com/caimei365/user/controller/LoginApi.java

@@ -3,6 +3,7 @@ package com.caimei365.user.controller;
 import com.caimei365.user.model.ResponseJson;
 import com.caimei365.user.model.vo.UserLoginVo;
 import com.caimei365.user.service.LoginService;
+import io.swagger.annotations.Api;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpHeaders;
 import org.springframework.web.bind.annotation.*;
@@ -15,6 +16,7 @@ import java.util.Map;
  * @author : Charles
  * @date : 2021/3/8
  */
+@Api(tags="登录API")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/user/login")

src/main/java/com/caimei365/user/controller/RegisterApi.java

@@ -9,12 +9,12 @@ import com.caimei365.user.model.dto.ShopRegisterDto;
 import com.caimei365.user.model.po.ClubPo;
 import com.caimei365.user.model.po.ShopPo;
 import com.caimei365.user.service.RegisterService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpHeaders;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
 
 
 /**
@@ -23,6 +23,7 @@ import org.springframework.web.bind.annotation.RestController;
  * @author : Charles
  * @date : 2021/3/10
  */
+@Api(tags="注册Api")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/user/register")
@@ -49,13 +50,16 @@ public class RegisterApi {
      * @param headers         HttpHeaders
      * @return ClubPo
      */
+    @ApiOperation("注册普通机构")
     @Idempotent(prefix="idempotent_club", keys={"#baseUser"}, expire=5)
     @PostMapping("/club")
-    public ResponseJson clubRegister(ClubRegisterDto clubRegisterDto,
-                                             String passWordConfirm,
-                                             String smsCode,
-                                             Integer isAgreed,
-                                             @RequestHeader HttpHeaders headers) {
+    public ResponseJson clubRegister(
+        ClubRegisterDto clubRegisterDto,
+        @ApiParam(required = true, value = "用户确认密码") @RequestParam("passWordConfirm") String passWordConfirm,
+        @ApiParam(required = true, value = "短信验证码") @RequestParam("smsCode") String smsCode,
+        @ApiParam(required = true, value = "是否同意勾选同意协议，1是，其他否") @RequestParam("isAgreed") Integer isAgreed,
+        @RequestHeader HttpHeaders headers
+    ) {
         return registerService.clubRegister(clubRegisterDto, passWordConfirm, smsCode, isAgreed, headers);
     }
 
@@ -90,8 +94,12 @@ public class RegisterApi {
      * @param headers   HttpHeaders
      * @return ClubPo
      */
+    @ApiOperation("普通机构升级会员机构")
     @PostMapping("/club/upgrade")
-    public ResponseJson clubUpgrade(ClubUpgradeDto upgradeDto, @RequestHeader HttpHeaders headers){
+    public ResponseJson clubUpgrade(
+        ClubUpgradeDto upgradeDto,
+        @RequestHeader HttpHeaders headers
+    ){
         return registerService.clubUpgrade(upgradeDto, headers);
     }
 
@@ -125,8 +133,13 @@ public class RegisterApi {
      * @param headers   HttpHeaders
      * @return ClubPo
      */
+    @ApiOperation("协销拉机构上线（机构注册）")
     @PostMapping("/club/online")
-    public ResponseJson<ClubPo> clubOnline(ClubOnlineDto onlineDto, Integer isAgreed, @RequestHeader HttpHeaders headers) {
+    public ResponseJson<ClubPo> clubOnline(
+        ClubOnlineDto onlineDto,
+        @ApiParam("是否同意勾选同意协议，1是，其他否") @RequestParam("isAgreed") Integer isAgreed,
+        @RequestHeader HttpHeaders headers
+    ) {
         return registerService.clubOnline(onlineDto, isAgreed, headers);
     }
 
@@ -156,18 +169,21 @@ public class RegisterApi {
      * @param passWordConfirm 用户确认密码
      * @param smsCode         短信验证码(旧：activationCode)
      * @param isAgreed        是否同意勾选同意协议，1是，其他否
-     * @param whichStep       注册步数
+     * @param whichStep       注册步数: PC(0)，小程序(1,2,3)
      * @param headers         HttpHeaders
      * @return ShopPo
      */
+    @ApiOperation("供应商注册")
     @Idempotent(prefix="idempotent_shop", keys={"#shopRegisterDto"}, expire=5)
     @PostMapping("/shop/applets")
-    public ResponseJson<ShopPo> shopRegister(ShopRegisterDto shopRegisterDto,
-                                             String passWordConfirm,
-                                             String smsCode,
-                                             Integer isAgreed,
-                                             Integer whichStep,
-                                             @RequestHeader HttpHeaders headers) {
+    public ResponseJson<ShopPo> shopRegister(
+        ShopRegisterDto shopRegisterDto,
+        @ApiParam("用户确认密码") @RequestParam("passWordConfirm") String passWordConfirm,
+        @ApiParam("短信验证码") @RequestParam("smsCode") String smsCode,
+        @ApiParam("是否同意勾选同意协议，1是，其他否") @RequestParam("isAgreed") Integer isAgreed,
+        @ApiParam("注册步数: PC(0)，小程序(1,2,3)") @RequestParam("whichStep") Integer whichStep,
+        @RequestHeader HttpHeaders headers
+    ) {
         return registerService.shopRegister(shopRegisterDto, passWordConfirm, smsCode, isAgreed, whichStep, headers);
     }
 

src/main/java/com/caimei365/user/controller/ShopApi.java

@@ -3,6 +3,7 @@ package com.caimei365.user.controller;
 import com.caimei365.user.model.ResponseJson;
 import com.caimei365.user.model.dto.ShopUpdateDto;
 import com.caimei365.user.service.ShopService;
+import io.swagger.annotations.Api;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
@@ -14,6 +15,7 @@ import java.util.Map;
  * @author : Charles
  * @date : 2021/3/9
  */
+@Api(tags="供应商用户API")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/user/shop")

src/main/java/com/caimei365/user/mapper/ShopMapper.java

@@ -1,8 +1,8 @@
 package com.caimei365.user.mapper;
 
 import com.caimei365.user.model.dto.ShopUpdateDto;
+import com.caimei365.user.model.po.ShopCertPo;
 import com.caimei365.user.model.po.UserPo;
-import com.caimei365.user.model.vo.ShopCertVo;
 import com.caimei365.user.model.vo.ShopVo;
 import org.apache.ibatis.annotations.Mapper;
 
@@ -53,5 +53,5 @@ public interface ShopMapper {
      * 保存供应商资质证书
      * @param shopCert  资质证书数据
      */
-    void insertShopCert(ShopCertVo shopCert);
+    void insertShopCert(ShopCertPo shopCert);
 }

src/main/java/com/caimei365/user/model/dto/ClubOnlineDto.java

@@ -1,5 +1,6 @@
 package com.caimei365.user.model.dto;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -13,75 +14,93 @@ import java.io.Serializable;
 @Data
 public class ClubOnlineDto implements Serializable {
     /**
-     * 协销用户ID
+     * 协销用户Id
      */
+    @ApiModelProperty("协销用户Id")
     private Integer userId;
     /**
      * 机构名称
      */
+    @ApiModelProperty("机构名称")
     private String name;
     /**
      * 机构简称
      */
+    @ApiModelProperty("机构简称")
     private String sName;
     /**
      * 企业绑定手机号
      */
+    @ApiModelProperty("企业绑定手机号")
     private String bindMobile;
     /**
      * 联系邮箱
      */
+    @ApiModelProperty("联系邮箱")
     private String contractEmail;
     /**
      * 联系人
      */
+    @ApiModelProperty("联系人")
     private String linkMan;
     /**
      * 省
      */
+    @ApiModelProperty("省")
     private Integer provinceId;
     /**
      * 市
      */
+    @ApiModelProperty("市")
     private Integer cityId;
     /**
-     * 地址ID
+     * 地址Id
      */
+    @ApiModelProperty("地址Id")
     private Integer townId;
     /**
      * 地址
      */
+    @ApiModelProperty("地址")
     private String address;
     /**
      * 门头照
      */
+    @ApiModelProperty("门头照")
     private String shopPhoto;
     /**
      * 营业执照(businessLicenseImage)
      */
+    @ApiModelProperty("营业执照(businessLicenseImage)")
     private String businessLicense;
     /**
      * 统一社会信用代码
      */
+    @ApiModelProperty("统一社会信用代码")
     private String socialCreditCode;
     /**
      * 一级分类为医美=1和生美=2
      */
+    @ApiModelProperty("一级分类为医美=1和生美=2")
     private Integer firstClubType;
     /**
      * 医美的二级分类为诊所=1、门诊=2、医院=3。  生美没有二级分类
      */
+    @ApiModelProperty("医美的二级分类为诊所=1、门诊=2、医院=3。  生美没有二级分类")
     private Integer secondClubType;
     /**
      * 若为医美分类下的门诊和医院则需要填写科室。
      */
+    @ApiModelProperty("若为医美分类下的门诊和医院则需要填写科室")
     private String department;
     /**
      * 医美分类必须上传医疗执业许可证(medicalPracticeLicenseImg)
      */
+    @ApiModelProperty("医美分类必须上传医疗执业许可证(medicalPracticeLicenseImg)")
     private String medicalPracticeLicense;
     /**
      * 主打项目(mainpro)
      */
+    @ApiModelProperty("主打项目(mainpro)")
     private String mainProduct;
 }

src/main/java/com/caimei365/user/model/dto/ClubRegisterDto.java

@@ -1,7 +1,10 @@
 package com.caimei365.user.model.dto;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
+import javax.validation.constraints.NotNull;
 import java.io.Serializable;
 
 /**
@@ -10,34 +13,44 @@ import java.io.Serializable;
  * @author : Charles
  * @date : 2021/3/11
  */
+@ApiModel("机构注册参数")
 @Data
 public class ClubRegisterDto implements Serializable {
     /**
      * 注册来源: 0网站 1小程序
      */
+    @ApiModelProperty("注册来源: 0网站 1小程序")
     private Integer source;
     /**
      * 用户名
      */
+    @ApiModelProperty("用户名")
     private String userName;
     /**
      * 企业绑定手机号
      */
+    @NotNull
+    @ApiModelProperty("企业绑定手机号")
     private String bindMobile;
     /**
      * 密码
      */
+    @NotNull
+    @ApiModelProperty("密码")
     private String password;
     /**
      * 微信unionId
      */
+    @ApiModelProperty("微信unionId")
     private String unionId;
     /**
      * 微信昵称
      */
+    @ApiModelProperty("微信昵称")
     private String nickName;
     /**
      * 微信头像(headimgurl)
      */
+    @ApiModelProperty("微信头像(headimgurl)")
     private String avatarUrl;
 }

src/main/java/com/caimei365/user/model/dto/ClubUpdateDto.java

@@ -1,5 +1,6 @@
 package com.caimei365.user.model.dto;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -13,87 +14,108 @@ import java.io.Serializable;
 @Data
 public class ClubUpdateDto implements Serializable {
     /**
-     * 机构ID
+     * 机构Id
      */
+    @ApiModelProperty("机构Id")
     private Integer clubId;
     /**
-     * 用户ID
+     * 用户Id
      */
+    @ApiModelProperty("用户Id")
     private Integer userId;
     /**
      * 机构名称
      */
+    @ApiModelProperty("机构名称")
     private String name;
     /**
      * 机构简称
      */
+    @ApiModelProperty("机构简称")
     private String sName;
     /**
      * 联系邮箱
      */
+    @ApiModelProperty("联系邮箱")
     private String contractEmail;
     /**
      * 固定电话
      */
+    @ApiModelProperty("固定电话")
     private String contractPhone;
     /**
      * 联系人
      */
+    @ApiModelProperty("联系人")
     private String linkMan;
     /**
      * 省
      */
+    @ApiModelProperty("省")
     private Integer provinceId;
     /**
      * 市
      */
+    @ApiModelProperty("市")
     private Integer cityId;
     /**
-     * 地址ID
+     * 地址Id
      */
+    @ApiModelProperty("地址Id")
     private Integer townId;
     /**
      * 地址
      */
+    @ApiModelProperty("地址")
     private String address;
     /**
      * 门头照
      */
+    @ApiModelProperty("门头照")
     private String shopPhoto;
     /**
      * 营业执照(businessLicenseImage)
      */
+    @ApiModelProperty("营业执照(businessLicenseImage)")
     private String businessLicense;
     /**
      * 统一社会信用代码
      */
+    @ApiModelProperty("统一社会信用代码")
     private String socialCreditCode;
     /**
      * 一级分类为医美=1和生美=2
      */
+    @ApiModelProperty("一级分类为医美=1和生美=2")
     private Integer firstClubType;
     /**
      * 医美的二级分类为诊所=1、门诊=2、医院=3。  生美没有二级分类
      */
+    @ApiModelProperty("医美的二级分类为诊所=1、门诊=2、医院=3。  生美没有二级分类")
     private Integer secondClubType;
     /**
      * 若为医美分类下的门诊和医院则需要填写科室。
      */
+    @ApiModelProperty("若为医美分类下的门诊和医院则需要填写科室")
     private String department;
     /**
      * 医美分类必须上传医疗执业许可证(medicalPracticeLicenseImg)
      */
+    @ApiModelProperty("医美分类必须上传医疗执业许可证(medicalPracticeLicenseImg)")
     private String medicalPracticeLicense;
     /**
      * 主打项目(mainpro)
      */
+    @ApiModelProperty("主打项目(mainpro)")
     private String mainProduct;
     /**
      * 传真
      */
+    @ApiModelProperty("传真")
     private String fax;
     /**
      * 公司简介(info)
      */
+    @ApiModelProperty("公司简介(info)")
     private String profile;
 }

src/main/java/com/caimei365/user/model/dto/ClubUpgradeDto.java

@@ -1,5 +1,6 @@
 package com.caimei365.user.model.dto;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -13,88 +14,109 @@ import java.io.Serializable;
 @Data
 public class ClubUpgradeDto implements Serializable {
     /**
-     * 机构ID
+     * 机构Id
      */
+    @ApiModelProperty("机构Id")
     private Integer clubId;
     /**
-     * 用户ID
+     * 用户Id
      */
+    @ApiModelProperty("用户Id")
     private Integer userId;
     /**
      * 机构名称
      */
+    @ApiModelProperty("机构名称")
     private String name;
     /**
      * 机构简称
      */
+    @ApiModelProperty("机构简称")
     private String sName;
     /**
      * 联系邮箱
      */
+    @ApiModelProperty("联系邮箱")
     private String contractEmail;
     /**
      * 固定电话
      */
+    @ApiModelProperty("固定电话")
     private String contractPhone;
     /**
      * 联系人
      */
+    @ApiModelProperty("联系人")
     private String linkMan;
     /**
      * 省
      */
+    @ApiModelProperty("省")
     private Integer provinceId;
     /**
      * 市
      */
+    @ApiModelProperty("市")
     private Integer cityId;
     /**
-     * 地址ID
+     * 地址Id
      */
+    @ApiModelProperty("地址Id")
     private Integer townId;
     /**
      * 地址
      */
+    @ApiModelProperty("地址")
     private String address;
     /**
      * 门头照
      */
+    @ApiModelProperty("门头照")
     private String shopPhoto;
     /**
      * 营业执照(businessLicenseImage)
      */
+    @ApiModelProperty("营业执照(businessLicenseImage)")
     private String businessLicense;
     /**
      * 统一社会信用代码
      */
+    @ApiModelProperty("统一社会信用代码")
     private String socialCreditCode;
     /**
      * 一级分类为医美=1和生美=2
      */
+    @ApiModelProperty("一级分类为医美=1和生美=2")
     private Integer firstClubType;
     /**
      * 医美的二级分类为诊所=1、门诊=2、医院=3。  生美没有二级分类
      */
+    @ApiModelProperty("医美的二级分类为诊所=1、门诊=2、医院=3。  生美没有二级分类")
     private Integer secondClubType;
     /**
      * 若为医美分类下的门诊和医院则需要填写科室。
      */
+    @ApiModelProperty("若为医美分类下的门诊和医院则需要填写科室")
     private String department;
     /**
      * 医美分类必须上传医疗执业许可证(medicalPracticeLicenseImg)
      */
+    @ApiModelProperty("医美分类必须上传医疗执业许可证(medicalPracticeLicenseImg)")
     private String medicalPracticeLicense;
     /**
      * 主打项目(mainpro)
      */
+    @ApiModelProperty("主打项目(mainpro)")
     private String mainProduct;
     /**
      * 传真
      */
+    @ApiModelProperty("传真")
     private String fax;
     /**
      * 公司简介(info)
      */
+    @ApiModelProperty("公司简介(info)")
     private String profile;
 
 }

src/main/java/com/caimei365/user/model/dto/ShopRegisterDto.java

@@ -1,5 +1,6 @@
 package com.caimei365.user.model.dto;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -15,66 +16,82 @@ public class ShopRegisterDto implements Serializable {
     /**
      * 注册来源: 0网站 1小程序
      */
+    @ApiModelProperty("注册来源: 0网站 1小程序")
     private Integer source;
     /**
      * 组织名称
      */
+    @ApiModelProperty("组织名称")
     private String name;
     /**
      * 供应商公司简称(sname)
      */
+    @ApiModelProperty("供应商公司简称(sname)")
     private String sName;
 
     /**
      * 企业绑定手机号
      */
+    @ApiModelProperty("企业绑定手机号")
     private String bindMobile;
     /**
      * 邮箱
      */
+    @ApiModelProperty("邮箱")
     private String email;
     /**
      * 密码
      */
+    @ApiModelProperty("密码")
     private String password;
     /**
      * 联系人
      */
+    @ApiModelProperty("联系人")
     private String linkMan;
     /**
-     * 省(provinceID)
+     * 省(provinceId)
      */
+    @ApiModelProperty("省")
     private Integer provinceId;
     /**
-     * 市(cityID)
+     * 市(cityId)
      */
+    @ApiModelProperty("市")
     private Integer cityId;
     /**
-     * 地址ID(townID)
+     * 地址Id(townId)
      */
+    @ApiModelProperty("地址Id")
     private Integer townId;
     /**
      * 地址
      */
+    @ApiModelProperty("地址")
     private String address;
     /**
      * 统一社会信用代码
      */
+    @ApiModelProperty("统一社会信用代码")
     private String socialCreditCode;
     /**
      * 营业执照(businessLicenseImage)
      */
+    @ApiModelProperty("营业执照(businessLicenseImage)")
     private String businessLicense;
     /**
      * 医疗=1和非医疗=2
      */
+    @ApiModelProperty("医疗=1和非医疗=2")
     private String firstShopType;
     /**
      * 医疗的二级分类 一类器械=1、二类器械 =2、三类器械=3、其他=4 /// 1和非医疗没有二级分类
      */
+    @ApiModelProperty("医疗的二级分类 一类器械=1、二类器械 =2、三类器械=3、其他=4")
     private String secondShopType;
     /**
      * 主打项目(mainpro)
      */
+    @ApiModelProperty("主打项目(mainpro)")
     private String mainProduct;
 }

src/main/java/com/caimei365/user/model/dto/ShopUpdateDto.java

@@ -1,5 +1,6 @@
 package com.caimei365.user.model.dto;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -13,107 +14,133 @@ import java.io.Serializable;
 @Data
 public class ShopUpdateDto implements Serializable {
     /**
-     * 供应商ID
+     * 供应商Id
      */
+    @ApiModelProperty("供应商Id")
     private Integer shopId;
     /**
-     * 用户ID
+     * 用户Id
      */
+    @ApiModelProperty("用户Id")
     private Integer userId;
     /**
      * 组织名称
      */
+    @ApiModelProperty("组织名称")
     private String name;
     /**
      * 供应商公司简称(sname)
      */
+    @ApiModelProperty("供应商公司简称(sname)")
     private String sName;
     /**
      * 邮箱
      */
+    @ApiModelProperty("邮箱")
     private String email;
     /**
      * 固定电话
      */
+    @ApiModelProperty("固定电话")
     private String contractPhone;
     /**
      * 联系人
      */
+    @ApiModelProperty("联系人")
     private String linkMan;
     /**
-     * 省(provinceID)
+     * 省(provinceId)
      */
+    @ApiModelProperty("省")
     private Integer provinceId;
     /**
-     * 市(cityID)
+     * 市(cityId)
      */
+    @ApiModelProperty("市")
     private Integer cityId;
     /**
-     * 地址ID(townID)
+     * 地址Id(townId)
      */
+    @ApiModelProperty("地址Id")
     private Integer townId;
     /**
      * 地址
      */
+    @ApiModelProperty("地址")
     private String address;
     /**
      * 统一社会信用代码(营业执照编号)
      */
+    @ApiModelProperty("统一社会信用代码(营业执照编号)")
     private String socialCreditCode;
     /**
      * 营业执照(businessLicenseImage)
      */
+    @ApiModelProperty("营业执照(businessLicenseImage)")
     private String businessLicense;
     /**
      * 医疗=1和非医疗=2
      */
+    @ApiModelProperty("医疗=1和非医疗=2")
     private String firstShopType;
     /**
      * 医疗的二级分类 一类器械=1、二类器械 =2、三类器械=3、其他=4 /// 1和非医疗没有二级分类
      */
+    @ApiModelProperty("医疗的二级分类 一类器械=1、二类器械 =2、三类器械=3、其他=4")
     private String secondShopType;
     /**
      * 主打项目(mainpro)
      */
+    @ApiModelProperty("主打项目(mainpro)")
     private String mainProduct;
     /**
      * 主打商品说明(productDesc)
      */
+    @ApiModelProperty("主打商品说明(productDesc)")
     private String mainProductDesc;
     /**
      * 法人代表
      */
+    @ApiModelProperty("法人代表")
     private String legalPerson;
     /**
      * 注册资本
      */
+    @ApiModelProperty("注册资本")
     private Double registeredCapital;
     /**
      * 传真号(fax)
      */
+    @ApiModelProperty("传真号")
     private String faxNumber;
     /**
      * 公司性质(nature)
      */
+    @ApiModelProperty("公司性质(nature)")
     private String companyNature;
     /**
      * 年营业额
      */
+    @ApiModelProperty("年营业额")
     private Double turnover;
     /**
      * 医疗执业许可证(medicalPracticeLicenseImg1)
      */
-    private String medicalPracticeLicenseImg;
+    @ApiModelProperty("医疗执业许可证(medicalPracticeLicenseImg1)")
+    private String medicalPracticeLicense;
     /**
      * 公司介绍(info)
      */
+    @ApiModelProperty("公司介绍(info)")
     private String shopDesc;
     /**
      * 经营范围
      */
+    @ApiModelProperty("经营范围")
     private String businessScope;
     /**
      * 公司LOGO
      */
+    @ApiModelProperty("公司LOGO")
     private String logo;
 }

src/main/java/com/caimei365/user/model/vo/ShopCertVo.java

@@ -1,17 +0,0 @@
-package com.caimei365.user.model.vo;
-
-import com.caimei365.user.model.po.ShopCertPo;
-import com.caimei365.user.model.po.ShopPo;
-import lombok.Data;
-import lombok.EqualsAndHashCode;
-
-/**
- * Description
- *
- * @author : Aslee
- * @date : 2021/3/17
- */
-@Data
-@EqualsAndHashCode(callSuper = true)
-public class ShopCertVo extends ShopCertPo {
-}

src/main/java/com/caimei365/user/model/vo/UserLoginVo.java

@@ -1,6 +1,7 @@
 package com.caimei365.user.model.vo;
 
-import com.fasterxml.jackson.annotation.JsonFormat;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -12,98 +13,122 @@ import java.util.Date;
  * @author : Charles
  * @date : 2021/3/10
  */
+@ApiModel("返回用户数据")
 @Data
 public class UserLoginVo implements Serializable {
     /**
-     * 用户ID
+     * 用户Id
      */
+    @ApiModelProperty("用户Id")
     private Integer userId;
     /**
-     * 机构ID
+     * 机构Id
      */
+    @ApiModelProperty("机构Id")
     private Integer clubId;
     /**
-     * 供应商ID
+     * 供应商Id
      */
+    @ApiModelProperty("供应商Id")
     private Integer shopId;
     /**
      * 协销Id
      */
+    @ApiModelProperty("协销Id")
     private Integer serviceProviderId;
     /**
      * 运营人员Id
      */
+    @ApiModelProperty("运营人员Id")
     private Integer operationId;
     /**
      * 企业账号名
      */
+    @ApiModelProperty("企业账号名")
     private Integer account;
     /**
      * 机构名称
      */
+    @ApiModelProperty("机构名称")
     private String name;
     /**
      * 用户名
      */
+    @ApiModelProperty("用户名")
     private String userName;
     /**
      * 邮箱
      */
+    @ApiModelProperty("邮箱")
     private String email;
     /**
      * 个人手机号码
      */
+    @ApiModelProperty("个人手机号码")
     private String mobile;
     /**
      * 企业绑定手机号
      */
+    @ApiModelProperty("企业绑定手机号")
     private String bindMobile;
     /**
      * 运营人员手机号
      */
+    @ApiModelProperty("运营人员手机号")
     private String operationMobile;
     /**
      * 密码
      */
+    @ApiModelProperty("密码")
     private String password;
     /**
      * 用户身份: 1协销 2会员机构 3供应商 4普通机构
      */
+    @ApiModelProperty("用户身份: 1协销 2会员机构 3供应商 4普通机构")
     private Integer userIdentity;
     /**
      * 用户权限: 2会员机构 3供应商 4协销 5普通机构
      */
+    @ApiModelProperty("用户权限: 2会员机构 3供应商 4协销 5普通机构")
     private Integer userPermission;
     /**
      * 机构状态：90:已上线，91:已冻结，92:审查资料未通过,待补充资料，1:待审查资料，2:电话预约，3:已预约，20:待确认，21:待拜访，30:待员工推荐，40:已完成第一次采购
      */
+    @ApiModelProperty("机构状态：90:已上线")
     private Integer clubStatus;
     /**
      * 供应商状态：90:已上线，91:已下线，92:审核不通过，3:待审核
      */
+    @ApiModelProperty("供应商状态：90:已上线")
     private Integer shopStatus;
     /**
      * 运营人员状态：1未绑定，2已绑定
      */
+    @ApiModelProperty("运营人员状态")
     private Integer operationStatus;
     /**
      * token
      */
+    @ApiModelProperty("token")
     private String token;
     /**
      * 微信unionId
      */
+    @ApiModelProperty("微信unionId")
     private String unionId;
     /**
      * 微信openId
      */
+    @ApiModelProperty("微信openId")
     private String openId;
     /**
      * 邀请码生成时间
      */
+    @ApiModelProperty("邀请码生成时间")
     private Date invitationCodeTime;
     /**
      * 删除标识：0有效，其它无效
      */
+    @ApiModelProperty("删除标识")
     private Integer delFlag;
 }

src/main/java/com/caimei365/user/service/impl/ShopServiceImpl.java

@@ -5,6 +5,7 @@ import com.caimei365.user.mapper.BaseMapper;
 import com.caimei365.user.mapper.ShopMapper;
 import com.caimei365.user.model.ResponseJson;
 import com.caimei365.user.model.dto.ShopUpdateDto;
+import com.caimei365.user.model.po.ShopCertPo;
 import com.caimei365.user.model.po.UserPo;
 import com.caimei365.user.model.vo.*;
 import com.caimei365.user.service.ShopService;
@@ -173,7 +174,7 @@ public class ShopServiceImpl implements ShopService {
         if (StringUtils.isNotBlank(shopUpdateDto.getSocialCreditCode())) {
             // 清除数据库证书数据
             shopMapper.deleteShopCertByShopId(shopUpdateDto.getShopId());
-            ShopCertVo shopCert = new ShopCertVo();
+            ShopCertPo shopCert = new ShopCertPo();
             shopCert.setShopId(shopUpdateDto.getShopId());
             shopCert.setShopCertTypeId(2);
             shopCert.setImage(operationLicence);

src/main/resources/bootstrap.yml

@@ -11,3 +11,8 @@ spring:
       label: master                     # 分支名称
       uri: http://localhost:18001       # 配置中心地址
       name: user                        # 配置文件名称
+
+swagger:
+  ui-config:
+    tags-sorter: method
+    operations-sorter: method

src/main/resources/mapper/ShopMapper.xml

@@ -88,7 +88,7 @@
                 turnover = #{turnover},
             </if>
             <if test="medicalPracticeLicenseImg != null">
-                medicalPracticeLicenseImg1 = #{medicalPracticeLicenseImg},
+                medicalPracticeLicenseImg1 = #{medicalPracticeLicense},
             </if>
             <if test="shopDesc != null">
                 info = #{shopDesc},