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/SysNoticeController.java | 18 ++++++------------
1 files changed, 6 insertions(+), 12 deletions(-)
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java
index 6febd3e..10a8371 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java
@@ -3,15 +3,14 @@
import cn.dev33.satoken.annotation.SaCheckPermission;
import com.ruoyi.common.annotation.Log;
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.enums.BusinessType;
import com.ruoyi.system.domain.SysNotice;
import com.ruoyi.system.service.ISysNoticeService;
-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.*;
@@ -22,7 +21,7 @@
* @author Lion Li
*/
@Validated
-@Api(value = "鍏憡淇℃伅鎺у埗鍣�", tags = {"鍏憡淇℃伅绠＄悊"})
+@Tag(name ="鍏憡淇℃伅鎺у埗鍣�", description = "鍏憡淇℃伅绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/notice")
@@ -33,7 +32,6 @@
/**
* 鑾峰彇閫氱煡鍏憡鍒楄〃
*/
- @ApiOperation("鑾峰彇閫氱煡鍏憡鍒楄〃")
@SaCheckPermission("system:notice:list")
@GetMapping("/list")
public TableDataInfo<SysNotice> list(SysNotice notice, PageQuery pageQuery) {
@@ -43,17 +41,15 @@
/**
* 鏍规嵁閫氱煡鍏憡缂栧彿鑾峰彇璇︾粏淇℃伅
*/
- @ApiOperation("鏍规嵁閫氱煡鍏憡缂栧彿鑾峰彇璇︾粏淇℃伅")
@SaCheckPermission("system:notice:query")
@GetMapping(value = "/{noticeId}")
- public R<SysNotice> getInfo(@ApiParam("鍏憡ID") @PathVariable Long noticeId) {
+ public R<SysNotice> getInfo(@Parameter(name = "鍏憡ID") @PathVariable Long noticeId) {
return R.ok(noticeService.selectNoticeById(noticeId));
}
/**
* 鏂板閫氱煡鍏憡
*/
- @ApiOperation("鏂板閫氱煡鍏憡")
@SaCheckPermission("system:notice:add")
@Log(title = "閫氱煡鍏憡", businessType = BusinessType.INSERT)
@PostMapping
@@ -64,7 +60,6 @@
/**
* 淇敼閫氱煡鍏憡
*/
- @ApiOperation("淇敼閫氱煡鍏憡")
@SaCheckPermission("system:notice:edit")
@Log(title = "閫氱煡鍏憡", businessType = BusinessType.UPDATE)
@PutMapping
@@ -75,11 +70,10 @@
/**
* 鍒犻櫎閫氱煡鍏憡
*/
- @ApiOperation("鍒犻櫎閫氱煡鍏憡")
@SaCheckPermission("system:notice:remove")
@Log(title = "閫氱煡鍏憡", businessType = BusinessType.DELETE)
@DeleteMapping("/{noticeIds}")
- public R<Void> remove(@ApiParam("鍏憡ID涓�") @PathVariable Long[] noticeIds) {
+ public R<Void> remove(@Parameter(name = "鍏憡ID涓�") @PathVariable Long[] noticeIds) {
return toAjax(noticeService.deleteNoticeByIds(noticeIds));
}
}
--
Gitblit v1.9.3