add 整合 springdoc-openapi-javadoc 基于代码注释生成文档

This commit is contained in:
疯狂的狮子li
2022-07-07 19:07:59 +08:00
parent 0b07780619
commit d9e54388e7
79 changed files with 26 additions and 548 deletions

View File

@ -33,7 +33,6 @@ import com.ruoyi.common.core.domain.TreeEntity;
@Data
@EqualsAndHashCode(callSuper = true)
@Schema(name = "${functionName}业务对象")
public class ${ClassName}Bo extends ${Entity} {
#foreach ($column in $columns)
@ -49,14 +48,12 @@ public class ${ClassName}Bo extends ${Entity} {
#set($Group="EditGroup.class")
#end
#if($column.isRequired == 1)
@Schema(name = "$column.columnComment", required = true)
#if($column.javaType == 'String')
@NotBlank(message = "$column.columnComment不能为空", groups = { $Group })
#else
@NotNull(message = "$column.columnComment不能为空", groups = { $Group })
#end
#else
@Schema(name = "$column.columnComment")
#end
private $column.javaType $column.javaField;

View File

@ -27,7 +27,6 @@ import ${packageName}.service.I${ClassName}Service;
import com.ruoyi.common.core.page.TableDataInfo;
#elseif($table.tree)
#end
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
/**
@ -48,7 +47,6 @@ public class ${ClassName}Controller extends BaseController {
/**
* 查询${functionName}列表
*/
@Operation(summary = "查询${functionName}列表")
@SaCheckPermission("${permissionPrefix}:list")
@GetMapping("/list")
#if($table.crud || $table.sub)
@ -65,7 +63,6 @@ public class ${ClassName}Controller extends BaseController {
/**
* 导出${functionName}列表
*/
@Operation(summary = "导出${functionName}列表")
@SaCheckPermission("${permissionPrefix}:export")
@Log(title = "${functionName}", businessType = BusinessType.EXPORT)
@PostMapping("/export")
@ -77,7 +74,6 @@ public class ${ClassName}Controller extends BaseController {
/**
* 获取${functionName}详细信息
*/
@Operation(summary = "获取${functionName}详细信息")
@SaCheckPermission("${permissionPrefix}:query")
@GetMapping("/{${pkColumn.javaField}}")
public R<${ClassName}Vo> getInfo(@Parameter(name = "主键")
@ -89,7 +85,6 @@ public class ${ClassName}Controller extends BaseController {
/**
* 新增${functionName}
*/
@Operation(summary = "新增${functionName}")
@SaCheckPermission("${permissionPrefix}:add")
@Log(title = "${functionName}", businessType = BusinessType.INSERT)
@RepeatSubmit()
@ -101,7 +96,6 @@ public class ${ClassName}Controller extends BaseController {
/**
* 修改${functionName}
*/
@Operation(summary = "修改${functionName}")
@SaCheckPermission("${permissionPrefix}:edit")
@Log(title = "${functionName}", businessType = BusinessType.UPDATE)
@RepeatSubmit()
@ -113,7 +107,6 @@ public class ${ClassName}Controller extends BaseController {
/**
* 删除${functionName}
*/
@Operation(summary = "删除${functionName}")
@SaCheckPermission("${permissionPrefix}:remove")
@Log(title = "${functionName}", businessType = BusinessType.DELETE)
@DeleteMapping("/{${pkColumn.javaField}s}")

View File

@ -21,7 +21,6 @@ import java.util.Date;
* @date ${datetime}
*/
@Data
@Schema(name = "${functionName}视图对象")
@ExcelIgnoreUnannotated
public class ${ClassName}Vo {
@ -47,7 +46,6 @@ public class ${ClassName}Vo {
#else
@ExcelProperty(value = "${comment}")
#end
@Schema(name = "$column.columnComment")
private $column.javaType $column.javaField;
#end