From 05502253961e36f173218e162b8135e2dca2716f Mon Sep 17 00:00:00 2001
From: zsz <312905679@qq.com>
Date: Fri, 10 Dec 2021 21:36:04 +0800
Subject: [PATCH] =?UTF-8?q?=E4=BB=A3=E7=A0=81=E7=94=9F=E6=88=90=E9=85=8D?=
=?UTF-8?q?=E5=90=88swagger=E7=94=9F=E6=88=90?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
ruoyi-admin/pom.xml | 12 ---------
ruoyi-common/pom.xml | 13 +++++++++
.../main/resources/vm/java/controller.java.vm | 27 +++++++------------
.../src/main/resources/vm/java/domain.java.vm | 4 +++
4 files changed, 26 insertions(+), 30 deletions(-)
diff --git a/ruoyi-admin/pom.xml b/ruoyi-admin/pom.xml
index ca0631980..9c0238d70 100644
--- a/ruoyi-admin/pom.xml
+++ b/ruoyi-admin/pom.xml
@@ -24,18 +24,6 @@
<optional>true</optional> <!-- 表示依赖不会传递 -->
</dependency>
- <!-- swagger3-->
- <dependency>
- <groupId>io.springfox</groupId>
- <artifactId>springfox-boot-starter</artifactId>
- </dependency>
-
- <!-- 防止进入swagger页面报类型转换错误，排除3.0.0中的引用，手动增加1.6.2版本 -->
- <dependency>
- <groupId>io.swagger</groupId>
- <artifactId>swagger-models</artifactId>
- <version>1.6.2</version>
- </dependency>
<!-- Mysql驱动包 -->
<dependency>
diff --git a/ruoyi-common/pom.xml b/ruoyi-common/pom.xml
index cbf4893a5..c3ea94f5d 100644
--- a/ruoyi-common/pom.xml
+++ b/ruoyi-common/pom.xml
@@ -125,6 +125,19 @@
<artifactId>javax.servlet-api</artifactId>
</dependency>
+ <!-- swagger3-->
+ <dependency>
+ <groupId>io.springfox</groupId>
+ <artifactId>springfox-boot-starter</artifactId>
+ </dependency>
+
+ <!-- 防止进入swagger页面报类型转换错误，排除3.0.0中的引用，手动增加1.6.2版本 -->
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-models</artifactId>
+ <version>1.6.2</version>
+ </dependency>
+
</dependencies>
</project>
\ No newline at end of file
diff --git a/ruoyi-generator/src/main/resources/vm/java/controller.java.vm b/ruoyi-generator/src/main/resources/vm/java/controller.java.vm
index ab19cf51f..55026372c 100644
--- a/ruoyi-generator/src/main/resources/vm/java/controller.java.vm
+++ b/ruoyi-generator/src/main/resources/vm/java/controller.java.vm
@@ -19,6 +19,8 @@ import com.ruoyi.common.enums.BusinessType;
import ${packageName}.domain.${ClassName};
import ${packageName}.service.I${ClassName}Service;
import com.ruoyi.common.utils.poi.ExcelUtil;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
#if($table.crud || $table.sub)
import com.ruoyi.common.core.page.TableDataInfo;
#elseif($table.tree)
@@ -31,15 +33,14 @@ import com.ruoyi.common.core.page.TableDataInfo;
* @date ${datetime}
*/
@RestController
+@Api(tags = {"${functionName}"})
@RequestMapping("/${moduleName}/${businessName}")
public class ${ClassName}Controller extends BaseController
{
@Autowired
private I${ClassName}Service ${className}Service;
- /**
- * 查询${functionName}列表
- */
+ @ApiOperation(value = "查询${functionName}列表")
@PreAuthorize("@ss.hasPermi('${permissionPrefix}:list')")
@GetMapping("/list")
#if($table.crud || $table.sub)
@@ -57,9 +58,7 @@ public class ${ClassName}Controller extends BaseController
}
#end
- /**
- * 导出${functionName}列表
- */
+ @ApiOperation(value = "导出${functionName}列表")
@PreAuthorize("@ss.hasPermi('${permissionPrefix}:export')")
@Log(title = "${functionName}", businessType = BusinessType.EXPORT)
@PostMapping("/export")
@@ -70,9 +69,7 @@ public class ${ClassName}Controller extends BaseController
util.exportExcel(response, list, "${functionName}数据");
}
- /**
- * 获取${functionName}详细信息
- */
+ @ApiOperation(value = "获取${functionName}详细信息")
@PreAuthorize("@ss.hasPermi('${permissionPrefix}:query')")
@GetMapping(value = "/{${pkColumn.javaField}}")
public AjaxResult getInfo(@PathVariable("${pkColumn.javaField}") ${pkColumn.javaType} ${pkColumn.javaField})
@@ -80,9 +77,7 @@ public class ${ClassName}Controller extends BaseController
return AjaxResult.success(${className}Service.select${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaField}));
}
- /**
- * 新增${functionName}
- */
+ @ApiOperation(value = "新增${functionName}")
@PreAuthorize("@ss.hasPermi('${permissionPrefix}:add')")
@Log(title = "${functionName}", businessType = BusinessType.INSERT)
@PostMapping
@@ -91,9 +86,7 @@ public class ${ClassName}Controller extends BaseController
return toAjax(${className}Service.insert${ClassName}(${className}));
}
- /**
- * 修改${functionName}
- */
+ @ApiOperation(value = "修改${functionName}")
@PreAuthorize("@ss.hasPermi('${permissionPrefix}:edit')")
@Log(title = "${functionName}", businessType = BusinessType.UPDATE)
@PutMapping
@@ -102,9 +95,7 @@ public class ${ClassName}Controller extends BaseController
return toAjax(${className}Service.update${ClassName}(${className}));
}
- /**
- * 删除${functionName}
- */
+ @ApiOperation(value = "删除${functionName}")
@PreAuthorize("@ss.hasPermi('${permissionPrefix}:remove')")
@Log(title = "${functionName}", businessType = BusinessType.DELETE)
@DeleteMapping("/{${pkColumn.javaField}s}")
diff --git a/ruoyi-generator/src/main/resources/vm/java/domain.java.vm b/ruoyi-generator/src/main/resources/vm/java/domain.java.vm
index 94a40a96f..77d0d9a9c 100644
--- a/ruoyi-generator/src/main/resources/vm/java/domain.java.vm
+++ b/ruoyi-generator/src/main/resources/vm/java/domain.java.vm
@@ -6,6 +6,8 @@ import ${import};
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import com.ruoyi.common.annotation.Excel;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
#if($table.crud || $table.sub)
import com.ruoyi.common.core.domain.BaseEntity;
#elseif($table.tree)
@@ -23,6 +25,7 @@ import com.ruoyi.common.core.domain.TreeEntity;
#elseif($table.tree)
#set($Entity="TreeEntity")
#end
+@ApiModel("${functionName}")
public class ${ClassName} extends ${Entity}
{
private static final long serialVersionUID = 1L;
@@ -46,6 +49,7 @@ public class ${ClassName} extends ${Entity}
@Excel(name = "${comment}")
#end
#end
+ @ApiModelProperty(value = "${column.columnComment}")
private $column.javaType $column.javaField;
#end