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-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java | 23 +++++++----------------
1 files changed, 7 insertions(+), 16 deletions(-)
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java
index 54e31e4..5cabe85 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java
@@ -4,16 +4,15 @@
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.constant.UserConstants;
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.domain.entity.SysDictType;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.service.ISysDictTypeService;
-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.*;
@@ -27,7 +26,7 @@
* @author Lion Li
*/
@Validated
-@Api(value = "鏁版嵁瀛楀吀淇℃伅鎺у埗鍣�", tags = {"鏁版嵁瀛楀吀淇℃伅绠＄悊"})
+@Tag(name ="鏁版嵁瀛楀吀淇℃伅鎺у埗鍣�", description = "鏁版嵁瀛楀吀淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/dict/type")
@@ -35,14 +34,12 @@
private final ISysDictTypeService dictTypeService;
- @ApiOperation("鏌ヨ瀛楀吀绫诲瀷鍒楄〃")
@SaCheckPermission("system:dict:list")
@GetMapping("/list")
public TableDataInfo<SysDictType> list(SysDictType dictType, PageQuery pageQuery) {
return dictTypeService.selectPageDictTypeList(dictType, pageQuery);
}
- @ApiOperation("瀵煎嚭瀛楀吀绫诲瀷鍒楄〃")
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:dict:export")
@PostMapping("/export")
@@ -54,17 +51,15 @@
/**
* 鏌ヨ瀛楀吀绫诲瀷璇︾粏
*/
- @ApiOperation("鏌ヨ瀛楀吀绫诲瀷璇︾粏")
@SaCheckPermission("system:dict:query")
@GetMapping(value = "/{dictId}")
- public R<SysDictType> getInfo(@ApiParam("瀛楀吀ID") @PathVariable Long dictId) {
+ public R<SysDictType> getInfo(@Parameter(name = "瀛楀吀ID") @PathVariable Long dictId) {
return R.ok(dictTypeService.selectDictTypeById(dictId));
}
/**
* 鏂板瀛楀吀绫诲瀷
*/
- @ApiOperation("鏂板瀛楀吀绫诲瀷")
@SaCheckPermission("system:dict:add")
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.INSERT)
@PostMapping
@@ -78,7 +73,6 @@
/**
* 淇敼瀛楀吀绫诲瀷
*/
- @ApiOperation("淇敼瀛楀吀绫诲瀷")
@SaCheckPermission("system:dict:edit")
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.UPDATE)
@PutMapping
@@ -92,19 +86,17 @@
/**
* 鍒犻櫎瀛楀吀绫诲瀷
*/
- @ApiOperation("鍒犻櫎瀛楀吀绫诲瀷")
@SaCheckPermission("system:dict:remove")
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.DELETE)
@DeleteMapping("/{dictIds}")
- public R<Void> remove(@ApiParam("瀛楀吀ID涓�") @PathVariable Long[] dictIds) {
+ public R<Void> remove(@Parameter(name = "瀛楀吀ID涓�") @PathVariable Long[] dictIds) {
dictTypeService.deleteDictTypeByIds(dictIds);
- return success();
+ return R.ok();
}
/**
* 鍒锋柊瀛楀吀缂撳瓨
*/
- @ApiOperation("鍒锋柊瀛楀吀缂撳瓨")
@SaCheckPermission("system:dict:remove")
@Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.CLEAN)
@DeleteMapping("/refreshCache")
@@ -116,7 +108,6 @@
/**
* 鑾峰彇瀛楀吀閫夋嫨妗嗗垪琛�
*/
- @ApiOperation("鑾峰彇瀛楀吀閫夋嫨妗嗗垪琛�")
@GetMapping("/optionselect")
public R<List<SysDictType>> optionselect() {
List<SysDictType> dictTypes = dictTypeService.selectDictTypeAll();
--
Gitblit v1.9.3