From d5d397b2e9f98b0700bbca744ee7ecb6a963be2d Mon Sep 17 00:00:00 2001
From: TinyAnts <tinyants@163.com>
Date: Thu, 16 Mar 2023 10:11:21 +0800
Subject: [PATCH] =?UTF-8?q?=E8=B0=83=E6=95=B4:=20=E4=BB=A3=E7=A0=81?=
 =?UTF-8?q?=E7=94=9F=E6=88=90=E5=99=A8=E6=94=AF=E6=8C=81Swagger=E7=94=9F?=
 =?UTF-8?q?=E6=88=90?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../main/resources/java/controller.java.vm    | 66 +++----------------
 .../src/main/resources/java/entity.java.vm    | 18 ++---
 .../main/resources/java/serviceImpl.java.vm   |  2 +-
 .../resources/java/validateCreate.java.vm     | 11 ++--
 .../resources/java/validateSearch.java.vm     | 14 ++--
 .../resources/java/validateUpdate.java.vm     |  4 ++
 .../src/main/resources/java/voDetail.java.vm  | 20 +++---
 .../src/main/resources/java/voListed.java.vm  | 21 +++---
 8 files changed, 49 insertions(+), 107 deletions(-)

diff --git a/server/like-generator/src/main/resources/java/controller.java.vm b/server/like-generator/src/main/resources/java/controller.java.vm
index 448cee89..8831ee98 100644
--- a/server/like-generator/src/main/resources/java/controller.java.vm
+++ b/server/like-generator/src/main/resources/java/controller.java.vm
@@ -3,7 +3,7 @@ package ${packageName}.admin.controller;
 #if(!$table.genTpl.equals("crud"))
 import com.alibaba.fastjson2.JSONArray;
 #end
-import ${packageName}.admin.config.aop.Log;
+import ${packageName}.admin.aop.Log;
 import ${packageName}.admin.service.I${EntityName}Service;
 import ${packageName}.admin.validate.commons.IdValidate;
 import ${packageName}.admin.validate.${EntityName}CreateValidate;
@@ -19,39 +19,24 @@ import ${packageName}.common.core.AjaxResult;
 import ${packageName}.common.core.PageResult;
 #end
 import ${packageName}.common.validator.annotation.IDMust;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
 
 import javax.annotation.Resource;
 
-#set($isAuthor = !$authorName.equals(""))
-/**
- * ${functionName}管理
-#if($isAuthor)
- * @author ${authorName}
-#end
- */
 @RestController
 @RequestMapping("api/${moduleName}")
+@Api(tags = "${functionName}管理")
 public class ${EntityName}Controller {
 
     @Resource
     I${EntityName}Service i${EntityName}Service;
 
-    /**
-     * ${functionName}列表
-     *
-     #if(!$authorName.equals(""))
-     * @author ${authorName}
-     #end
-     #if($table.genTpl.equals("crud"))
-     * @param pageValidate 分页参数
-     #end
-     * @param searchValidate 搜索参数
-     * @return AjaxResult<Object>
-     */
     #if($table.genTpl.equals("crud"))
     @GetMapping("/list")
+    @ApiOperation(value="${functionName}列表")
     public AjaxResult<PageResult<${EntityName}ListedVo>> list(@Validated PageValidate pageValidate,
                                                      @Validated ${EntityName}SearchValidate searchValidate) {
         PageResult<${EntityName}ListedVo> list = i${EntityName}Service.list(pageValidate, searchValidate);
@@ -59,70 +44,39 @@ public class ${EntityName}Controller {
     }
     #else
     @GetMapping("/list")
+    @ApiOperation(value="${functionName}列表")
     public AjaxResult<JSONArray> list(@Validated ${EntityName}SearchValidate searchValidate) {
         JSONArray list = i${EntityName}Service.list(searchValidate);
         return AjaxResult.success(list);
     }
     #end
 
-    /**
-     * ${functionName}详情
-     *
-     #if(!$authorName.equals(""))
-     * @author ${authorName}
-     #end
-     * @param id 主键ID
-     * @return AjaxResult<${EntityName}DetailVo>
-     */
     @GetMapping("/detail")
+    @ApiOperation(value="${functionName}详情")
     public AjaxResult<${EntityName}DetailVo> detail(@Validated @IDMust() @RequestParam("id") Integer id) {
         ${EntityName}DetailVo detail = i${EntityName}Service.detail(id);
         return AjaxResult.success(detail);
     }
 
-    /**
-     * ${functionName}新增
-     *
-     #if(!$authorName.equals(""))
-     * @author ${authorName}
-     #end
-     * @param createValidate 参数
-     * @return AjaxResult<Object>
-     */
     @Log(title = "${functionName}新增")
     @PostMapping("/add")
+    @ApiOperation(value="${functionName}新增")
     public AjaxResult<Object> add(@Validated @RequestBody ${EntityName}CreateValidate createValidate) {
         i${EntityName}Service.add(createValidate);
         return AjaxResult.success();
     }
 
-    /**
-     * ${functionName}编辑
-     *
-     #if(!$authorName.equals(""))
-     * @author ${authorName}
-     #end
-     * @param updateValidate 参数
-     * @return AjaxResult<Object>
-     */
     @Log(title = "${functionName}编辑")
     @PostMapping("/edit")
+    @ApiOperation(value="${functionName}编辑")
     public AjaxResult<Object> edit(@Validated @RequestBody ${EntityName}UpdateValidate updateValidate) {
         i${EntityName}Service.edit(updateValidate);
         return AjaxResult.success();
     }
 
-    /**
-     * ${functionName}删除
-     *
-     #if(!$authorName.equals(""))
-     * @author ${authorName}
-     #end
-     * @param idValidate 参数
-     * @return AjaxResult<Object>
-     */
     @Log(title = "${functionName}删除")
     @PostMapping("/del")
+    @ApiOperation(value="${functionName}删除")
     public AjaxResult<Object> del(@Validated @RequestBody IdValidate idValidate) {
         #set($AttrName=$primaryKey.substring(0,1).toUpperCase() + ${primaryKey.substring(1)})
         i${EntityName}Service.del(idValidate.getId());
diff --git a/server/like-generator/src/main/resources/java/entity.java.vm b/server/like-generator/src/main/resources/java/entity.java.vm
index b3c186c3..d143fcca 100644
--- a/server/like-generator/src/main/resources/java/entity.java.vm
+++ b/server/like-generator/src/main/resources/java/entity.java.vm
@@ -2,6 +2,8 @@ package ${packageName}.common.entity;
 
 import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -14,26 +16,18 @@ import java.util.Date;
 #end
 #end
 
-#set($isAuthor = !$authorName.equals(""))
-/**
- * ${functionName}实体
-#if($isAuthor)
- * @author ${authorName}
-#end
- */
 @Data
+@ApiModel("${functionName}实体")
 public class ${EntityName} implements Serializable {
 
     private static final long serialVersionUID = 1L;
 
  #foreach ($column in $columns)
-    #if($notesType.equals("top"))
-    // ${column.columnComment}
-    #end
     #if($column.isPk)
     @TableId(value="${column.columnName}", type= IdType.AUTO)
     #end
-    private ${column.javaType} ${column.javaField}; #if($notesType.equals("right"))// ${column.columnComment}#end
- #end
+    @ApiModelProperty(value = "${column.columnComment}")
+    private ${column.javaType} ${column.javaField};
 
+ #end
 }
\ No newline at end of file
diff --git a/server/like-generator/src/main/resources/java/serviceImpl.java.vm b/server/like-generator/src/main/resources/java/serviceImpl.java.vm
index fb7fa609..7b0e0a50 100644
--- a/server/like-generator/src/main/resources/java/serviceImpl.java.vm
+++ b/server/like-generator/src/main/resources/java/serviceImpl.java.vm
@@ -22,7 +22,7 @@ import ${packageName}.common.core.PageResult;
 #end
 import ${packageName}.common.entity.${EntityName};
 import ${packageName}.common.mapper.${EntityName}Mapper;
-import ${packageName}.common.util.ArrayUtils;
+import ${packageName}.common.util.ListUtils;
 import ${packageName}.common.util.TimeUtils;
 import ${packageName}.common.util.UrlUtils;
 import org.springframework.beans.BeanUtils;
diff --git a/server/like-generator/src/main/resources/java/validateCreate.java.vm b/server/like-generator/src/main/resources/java/validateCreate.java.vm
index 2176389f..cbfe3e8c 100644
--- a/server/like-generator/src/main/resources/java/validateCreate.java.vm
+++ b/server/like-generator/src/main/resources/java/validateCreate.java.vm
@@ -1,5 +1,7 @@
 package ${packageName}.admin.validate;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import java.io.Serializable;
 #foreach ($column in $columns)
@@ -12,14 +14,8 @@ import java.util.Date;
 #end
 import javax.validation.constraints.*;
 
-#set($isAuthor = !$authorName.equals(""))
-/**
- * ${functionName}参数
-#if($isAuthor)
- * @author ${authorName}
-#end
-*/
 @Data
+@ApiModel("${functionName}创建参数")
 public class ${EntityName}CreateValidate implements Serializable {
 
     private static final long serialVersionUID = 1L;
@@ -29,6 +25,7 @@ public class ${EntityName}CreateValidate implements Serializable {
     #if($column.isRequired==1)
     @NotNull(message = "${column.javaField}参数缺失")
     #end
+    @ApiModelProperty(value = "${column.columnComment}")
     private ${column.javaType} ${column.javaField};
 
 #end
diff --git a/server/like-generator/src/main/resources/java/validateSearch.java.vm b/server/like-generator/src/main/resources/java/validateSearch.java.vm
index c45ff115..6efd6170 100644
--- a/server/like-generator/src/main/resources/java/validateSearch.java.vm
+++ b/server/like-generator/src/main/resources/java/validateSearch.java.vm
@@ -1,5 +1,7 @@
 package ${packageName}.admin.validate;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import java.io.Serializable;
 #foreach ($column in $columns)
@@ -11,14 +13,8 @@ import java.util.Date;
 #end
 #end
 
-#set($isAuthor = !$authorName.equals(""))
-/**
- * ${functionName}参数
-#if($isAuthor)
- * @author ${authorName}
-#end
- */
 @Data
+@ApiModel("${functionName}搜素参数")
 public class ${EntityName}SearchValidate implements Serializable {
 
     private static final long serialVersionUID = 1L;
@@ -26,9 +22,13 @@ public class ${EntityName}SearchValidate implements Serializable {
 #foreach ($column in $columns)
 #if($column.isQuery==1)
     #if ($column.columnName.equals("create_time") || $column.columnName.equals("update_time") || $column.columnName.equals("delete_time"))
+    @ApiModelProperty(value = "开始时间")
     private String ${column.javaField}Start;
+
+    @ApiModelProperty(value = "结束时间")
     private String ${column.javaField}End;
     #else
+    @ApiModelProperty(value = "${column.columnComment}")
     private ${column.javaType} ${column.javaField};
     #end
 
diff --git a/server/like-generator/src/main/resources/java/validateUpdate.java.vm b/server/like-generator/src/main/resources/java/validateUpdate.java.vm
index 98d05564..9bd0f15b 100644
--- a/server/like-generator/src/main/resources/java/validateUpdate.java.vm
+++ b/server/like-generator/src/main/resources/java/validateUpdate.java.vm
@@ -1,5 +1,7 @@
 package ${packageName}.admin.validate;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import java.io.Serializable;
 import javax.validation.constraints.*;
@@ -21,6 +23,7 @@ import ${packageName}.common.validator.annotation.IDMust;
 #end
  */
 @Data
+@ApiModel("${functionName}更新参数")
 public class ${EntityName}UpdateValidate implements Serializable {
 
     private static final long serialVersionUID = 1L;
@@ -33,6 +36,7 @@ public class ${EntityName}UpdateValidate implements Serializable {
     #if($column.isPk==1)
     @IDMust(message = "${column.javaField}参数必传且需大于0")
     #end
+    @ApiModelProperty(value = "${column.columnComment}")
     private ${column.javaType} ${column.javaField};
 
 #end
diff --git a/server/like-generator/src/main/resources/java/voDetail.java.vm b/server/like-generator/src/main/resources/java/voDetail.java.vm
index a3659274..7d9936ce 100644
--- a/server/like-generator/src/main/resources/java/voDetail.java.vm
+++ b/server/like-generator/src/main/resources/java/voDetail.java.vm
@@ -1,5 +1,7 @@
 package ${packageName}.admin.vo;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -12,28 +14,22 @@ import java.util.Date;
 #end
 #end
 
-#set($isAuthor = !$authorName.equals(""))
-/**
- * ${EntityName}Vo
-#if($isAuthor)
- * @author ${authorName}
-#end
- */
 @Data
+@ApiModel("${functionName}详情Vo")
 public class ${EntityName}DetailVo implements Serializable {
 
     private static final long serialVersionUID = 1L;
 
 #foreach ($column in $columns)
 #if($column.isEdit==1 || $column.isPk==1)
-    #if($notesType.equals("top"))
-    // ${column.columnComment}
-    #end
     #if($dateFields.contains($column.columnName))
-    private String ${column.javaField}; // ${column.columnComment}
+    @ApiModelProperty(value = "${column.columnComment}")
+    private String ${column.javaField};
     #else
-    private ${column.javaType} ${column.javaField};  #if($notesType.equals("right"))// ${column.columnComment}#end
+    @ApiModelProperty(value = "${column.columnComment}")
+    private ${column.javaType} ${column.javaField};
     #end
+
 #end
 #end
 
diff --git a/server/like-generator/src/main/resources/java/voListed.java.vm b/server/like-generator/src/main/resources/java/voListed.java.vm
index 98669f74..b7f75dd1 100644
--- a/server/like-generator/src/main/resources/java/voListed.java.vm
+++ b/server/like-generator/src/main/resources/java/voListed.java.vm
@@ -1,5 +1,7 @@
 package ${packageName}.admin.vo;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -12,27 +14,22 @@ import java.util.Date;
 #end
 #end
 
-#set($isAuthor = !$authorName.equals(""))
-/**
- * ${EntityName}Vo
-#if($isAuthor)
- * @author ${authorName}
-#end
- */
 @Data
+@ApiModel("${functionName}列表Vo")
 public class ${EntityName}ListedVo implements Serializable {
 
     private static final long serialVersionUID = 1L;
 
 #foreach ($column in $columns)
 #if($column.isList==1 || $column.isPk==1)
-    #if($notesType.equals("top"))
-    // ${column.columnComment}
-    #end
     #if($dateFields.contains($column.columnName))
-    private String ${column.javaField}; // ${column.columnComment}
+    @ApiModelProperty(value = "${column.columnComment}")
+    private String ${column.javaField};
+
     #else
-    private ${column.javaType} ${column.javaField};  #if($notesType.equals("right"))// ${column.columnComment}#end
+    @ApiModelProperty(value = "${column.columnComment}")
+    private ${column.javaType} ${column.javaField};
+
     #end
 #end
 #end