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-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java | 17 +++++------------ 1 files changed, 5 insertions(+), 12 deletions(-) diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java index 64f36c9..c6bad67 100644 --- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java +++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestTreeController.java @@ -13,9 +13,8 @@ import com.ruoyi.demo.domain.bo.TestTreeBo; import com.ruoyi.demo.domain.vo.TestTreeVo; import com.ruoyi.demo.service.ITestTreeService; -import io.swagger.annotations.Api; -import io.swagger.annotations.ApiOperation; -import io.swagger.annotations.ApiParam; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.*; @@ -33,7 +32,7 @@ * @date 2021-07-26 */ @Validated -@Api(value = "娴嬭瘯鏍戣〃鎺у埗鍣�", tags = {"娴嬭瘯鏍戣〃绠$悊"}) +@Tag(name ="娴嬭瘯鏍戣〃鎺у埗鍣�", description = "娴嬭瘯鏍戣〃绠$悊") @RequiredArgsConstructor @RestController @RequestMapping("/demo/tree") @@ -44,7 +43,6 @@ /** * 鏌ヨ娴嬭瘯鏍戣〃鍒楄〃 */ - @ApiOperation("鏌ヨ娴嬭瘯鏍戣〃鍒楄〃") @SaCheckPermission("demo:tree:list") @GetMapping("/list") public R<List<TestTreeVo>> list(@Validated(QueryGroup.class) TestTreeBo bo) { @@ -55,7 +53,6 @@ /** * 瀵煎嚭娴嬭瘯鏍戣〃鍒楄〃 */ - @ApiOperation("瀵煎嚭娴嬭瘯鏍戣〃鍒楄〃") @SaCheckPermission("demo:tree:export") @Log(title = "娴嬭瘯鏍戣〃", businessType = BusinessType.EXPORT) @GetMapping("/export") @@ -67,10 +64,9 @@ /** * 鑾峰彇娴嬭瘯鏍戣〃璇︾粏淇℃伅 */ - @ApiOperation("鑾峰彇娴嬭瘯鏍戣〃璇︾粏淇℃伅") @SaCheckPermission("demo:tree:query") @GetMapping("/{id}") - public R<TestTreeVo> getInfo(@ApiParam("娴嬭瘯鏍慖D") + public R<TestTreeVo> getInfo(@Parameter(name = "娴嬭瘯鏍慖D") @NotNull(message = "涓婚敭涓嶈兘涓虹┖") @PathVariable("id") Long id) { return R.ok(iTestTreeService.queryById(id)); @@ -79,7 +75,6 @@ /** * 鏂板娴嬭瘯鏍戣〃 */ - @ApiOperation("鏂板娴嬭瘯鏍戣〃") @SaCheckPermission("demo:tree:add") @Log(title = "娴嬭瘯鏍戣〃", businessType = BusinessType.INSERT) @RepeatSubmit @@ -91,7 +86,6 @@ /** * 淇敼娴嬭瘯鏍戣〃 */ - @ApiOperation("淇敼娴嬭瘯鏍戣〃") @SaCheckPermission("demo:tree:edit") @Log(title = "娴嬭瘯鏍戣〃", businessType = BusinessType.UPDATE) @RepeatSubmit @@ -103,11 +97,10 @@ /** * 鍒犻櫎娴嬭瘯鏍戣〃 */ - @ApiOperation("鍒犻櫎娴嬭瘯鏍戣〃") @SaCheckPermission("demo:tree:remove") @Log(title = "娴嬭瘯鏍戣〃", businessType = BusinessType.DELETE) @DeleteMapping("/{ids}") - public R<Void> remove(@ApiParam("娴嬭瘯鏍慖D涓�") + public R<Void> remove(@Parameter(name = "娴嬭瘯鏍慖D涓�") @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖") @PathVariable Long[] ids) { return toAjax(iTestTreeService.deleteWithValidByIds(Arrays.asList(ids), true) ? 1 : 0); -- Gitblit v1.9.3