From d9e54388e7fde2462e8b7e0165c5e7da3f202593 Mon Sep 17 00:00:00 2001 From: 疯狂的狮子li <15040126243@163.com> Date: 星期四, 07 七月 2022 19:07:59 +0800 Subject: [PATCH] add 整合 springdoc-openapi-javadoc 基于代码注释生成文档 --- ruoyi-generator/src/main/resources/vm/java/controller.java.vm | 16 ++++------------ 1 files changed, 4 insertions(+), 12 deletions(-) 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 6b2fc65..5b30764 100644 --- a/ruoyi-generator/src/main/resources/vm/java/controller.java.vm +++ b/ruoyi-generator/src/main/resources/vm/java/controller.java.vm @@ -27,9 +27,7 @@ import com.ruoyi.common.core.page.TableDataInfo; #elseif($table.tree) #end -import io.swagger.annotations.Api; -import io.swagger.annotations.ApiParam; -import io.swagger.annotations.ApiOperation; +import io.swagger.v3.oas.annotations.tags.Tag; /** * ${functionName}Controller @@ -38,7 +36,7 @@ * @date ${datetime} */ @Validated -@Api(value = "${functionName}鎺у埗鍣�", tags = {"${functionName}绠$悊"}) +@Tag(name ="${functionName}鎺у埗鍣�", description = "${functionName}绠$悊") @RequiredArgsConstructor @RestController @RequestMapping("/${moduleName}/${businessName}") @@ -49,7 +47,6 @@ /** * 鏌ヨ${functionName}鍒楄〃 */ - @ApiOperation("鏌ヨ${functionName}鍒楄〃") @SaCheckPermission("${permissionPrefix}:list") @GetMapping("/list") #if($table.crud || $table.sub) @@ -66,7 +63,6 @@ /** * 瀵煎嚭${functionName}鍒楄〃 */ - @ApiOperation("瀵煎嚭${functionName}鍒楄〃") @SaCheckPermission("${permissionPrefix}:export") @Log(title = "${functionName}", businessType = BusinessType.EXPORT) @PostMapping("/export") @@ -78,10 +74,9 @@ /** * 鑾峰彇${functionName}璇︾粏淇℃伅 */ - @ApiOperation("鑾峰彇${functionName}璇︾粏淇℃伅") @SaCheckPermission("${permissionPrefix}:query") @GetMapping("/{${pkColumn.javaField}}") - public R<${ClassName}Vo> getInfo(@ApiParam("涓婚敭") + public R<${ClassName}Vo> getInfo(@Parameter(name = "涓婚敭") @NotNull(message = "涓婚敭涓嶈兘涓虹┖") @PathVariable("${pkColumn.javaField}") ${pkColumn.javaType} ${pkColumn.javaField}) { return R.ok(i${ClassName}Service.queryById(${pkColumn.javaField})); @@ -90,7 +85,6 @@ /** * 鏂板${functionName} */ - @ApiOperation("鏂板${functionName}") @SaCheckPermission("${permissionPrefix}:add") @Log(title = "${functionName}", businessType = BusinessType.INSERT) @RepeatSubmit() @@ -102,7 +96,6 @@ /** * 淇敼${functionName} */ - @ApiOperation("淇敼${functionName}") @SaCheckPermission("${permissionPrefix}:edit") @Log(title = "${functionName}", businessType = BusinessType.UPDATE) @RepeatSubmit() @@ -114,11 +107,10 @@ /** * 鍒犻櫎${functionName} */ - @ApiOperation("鍒犻櫎${functionName}") @SaCheckPermission("${permissionPrefix}:remove") @Log(title = "${functionName}", businessType = BusinessType.DELETE) @DeleteMapping("/{${pkColumn.javaField}s}") - public R<Void> remove(@ApiParam("涓婚敭涓�") + public R<Void> remove(@Parameter(name = "涓婚敭涓�") @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖") @PathVariable ${pkColumn.javaType}[] ${pkColumn.javaField}s) { return toAjax(i${ClassName}Service.deleteWithValidByIds(Arrays.asList(${pkColumn.javaField}s), true) ? 1 : 0); -- Gitblit v1.9.3