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/TestDemoController.java | 26 ++++++++++----------------
1 files changed, 10 insertions(+), 16 deletions(-)
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java
index 9f00c07..50bcbd0 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestDemoController.java
@@ -5,8 +5,8 @@
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.annotation.RepeatSubmit;
import com.ruoyi.common.core.controller.BaseController;
-import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.domain.PageQuery;
+import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.core.validate.AddGroup;
import com.ruoyi.common.core.validate.EditGroup;
@@ -20,7 +20,10 @@
import com.ruoyi.demo.domain.bo.TestDemoImportVo;
import com.ruoyi.demo.domain.vo.TestDemoVo;
import com.ruoyi.demo.service.ITestDemoService;
-import io.swagger.annotations.*;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.Parameters;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@@ -29,7 +32,6 @@
import javax.servlet.http.HttpServletResponse;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
-import java.io.File;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;
@@ -41,7 +43,7 @@
* @date 2021-07-26
*/
@Validated
-@Api(value = "娴嬭瘯鍗曡〃鎺у埗鍣�", tags = {"娴嬭瘯鍗曡〃绠＄悊"})
+@Tag(name ="娴嬭瘯鍗曡〃鎺у埗鍣�", description = "娴嬭瘯鍗曡〃绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/demo")
@@ -52,7 +54,6 @@
/**
* 鏌ヨ娴嬭瘯鍗曡〃鍒楄〃
*/
- @ApiOperation("鏌ヨ娴嬭瘯鍗曡〃鍒楄〃")
@SaCheckPermission("demo:demo:list")
@GetMapping("/list")
public TableDataInfo<TestDemoVo> list(@Validated(QueryGroup.class) TestDemoBo bo, PageQuery pageQuery) {
@@ -62,16 +63,14 @@
/**
* 鑷畾涔夊垎椤垫煡璇�
*/
- @ApiOperation("鑷畾涔夊垎椤垫煡璇�")
@SaCheckPermission("demo:demo:list")
@GetMapping("/page")
public TableDataInfo<TestDemoVo> page(@Validated(QueryGroup.class) TestDemoBo bo, PageQuery pageQuery) {
return iTestDemoService.customPageList(bo, pageQuery);
}
- @ApiOperation("瀵煎叆娴嬭瘯-鏍￠獙")
- @ApiImplicitParams({
- @ApiImplicitParam(name = "file", value = "瀵煎叆鏂囦欢", paramType = "query", dataTypeClass = File.class, required = true),
+ @Parameters({
+ @Parameter(name = "file", description = "瀵煎叆鏂囦欢", in = ParameterIn.QUERY, required = true),
})
@Log(title = "娴嬭瘯鍗曡〃", businessType = BusinessType.IMPORT)
@SaCheckPermission("demo:demo:import")
@@ -87,7 +86,6 @@
/**
* 瀵煎嚭娴嬭瘯鍗曡〃鍒楄〃
*/
- @ApiOperation("瀵煎嚭娴嬭瘯鍗曡〃鍒楄〃")
@SaCheckPermission("demo:demo:export")
@Log(title = "娴嬭瘯鍗曡〃", businessType = BusinessType.EXPORT)
@PostMapping("/export")
@@ -103,10 +101,9 @@
/**
* 鑾峰彇娴嬭瘯鍗曡〃璇︾粏淇℃伅
*/
- @ApiOperation("鑾峰彇娴嬭瘯鍗曡〃璇︾粏淇℃伅")
@SaCheckPermission("demo:demo:query")
@GetMapping("/{id}")
- public R<TestDemoVo> getInfo(@ApiParam("娴嬭瘯ID")
+ public R<TestDemoVo> getInfo(@Parameter(name = "娴嬭瘯ID")
@NotNull(message = "涓婚敭涓嶈兘涓虹┖")
@PathVariable("id") Long id) {
return R.ok(iTestDemoService.queryById(id));
@@ -115,7 +112,6 @@
/**
* 鏂板娴嬭瘯鍗曡〃
*/
- @ApiOperation("鏂板娴嬭瘯鍗曡〃")
@SaCheckPermission("demo:demo:add")
@Log(title = "娴嬭瘯鍗曡〃", businessType = BusinessType.INSERT)
@RepeatSubmit(interval = 2, timeUnit = TimeUnit.SECONDS, message = "{repeat.submit.message}")
@@ -130,7 +126,6 @@
/**
* 淇敼娴嬭瘯鍗曡〃
*/
- @ApiOperation("淇敼娴嬭瘯鍗曡〃")
@SaCheckPermission("demo:demo:edit")
@Log(title = "娴嬭瘯鍗曡〃", businessType = BusinessType.UPDATE)
@RepeatSubmit
@@ -142,11 +137,10 @@
/**
* 鍒犻櫎娴嬭瘯鍗曡〃
*/
- @ApiOperation("鍒犻櫎娴嬭瘯鍗曡〃")
@SaCheckPermission("demo:demo:remove")
@Log(title = "娴嬭瘯鍗曡〃", businessType = BusinessType.DELETE)
@DeleteMapping("/{ids}")
- public R<Void> remove(@ApiParam("娴嬭瘯ID涓�")
+ public R<Void> remove(@Parameter(name = "娴嬭瘯ID涓�")
@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
@PathVariable Long[] ids) {
return toAjax(iTestDemoService.deleteWithValidByIds(Arrays.asList(ids), true) ? 1 : 0);
--
Gitblit v1.9.3