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/SysPostController.java | 46 +++++++++++++++++++---------------------------
1 files changed, 19 insertions(+), 27 deletions(-)
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java
index b41d75b..a78ac4b 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysPostController.java
@@ -4,17 +4,16 @@
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.AjaxResult;
+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.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysPost;
import com.ruoyi.system.service.ISysPostService;
-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.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@@ -27,8 +26,8 @@
* @author Lion Li
*/
@Validated
-@Api(value = "宀椾綅淇℃伅鎺у埗鍣�", tags = {"宀椾綅淇℃伅绠＄悊"})
-@RequiredArgsConstructor(onConstructor_ = @Autowired)
+@Tag(name ="宀椾綅淇℃伅鎺у埗鍣�", description = "宀椾綅淇℃伅绠＄悊")
+@RequiredArgsConstructor
@RestController
@RequestMapping("/system/post")
public class SysPostController extends BaseController {
@@ -38,14 +37,12 @@
/**
* 鑾峰彇宀椾綅鍒楄〃
*/
- @ApiOperation("鑾峰彇宀椾綅鍒楄〃")
@SaCheckPermission("system:post:list")
@GetMapping("/list")
- public TableDataInfo<SysPost> list(SysPost post) {
- return postService.selectPagePostList(post);
+ public TableDataInfo<SysPost> list(SysPost post, PageQuery pageQuery) {
+ return postService.selectPagePostList(post, pageQuery);
}
- @ApiOperation("瀵煎嚭宀椾綅鍒楄〃")
@Log(title = "宀椾綅绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:post:export")
@PostMapping("/export")
@@ -57,25 +54,23 @@
/**
* 鏍规嵁宀椾綅缂栧彿鑾峰彇璇︾粏淇℃伅
*/
- @ApiOperation("鏍规嵁宀椾綅缂栧彿鑾峰彇璇︾粏淇℃伅")
@SaCheckPermission("system:post:query")
@GetMapping(value = "/{postId}")
- public AjaxResult<SysPost> getInfo(@ApiParam("宀椾綅ID") @PathVariable Long postId) {
- return AjaxResult.success(postService.selectPostById(postId));
+ public R<SysPost> getInfo(@Parameter(name = "宀椾綅ID") @PathVariable Long postId) {
+ return R.ok(postService.selectPostById(postId));
}
/**
* 鏂板宀椾綅
*/
- @ApiOperation("鏂板宀椾綅")
@SaCheckPermission("system:post:add")
@Log(title = "宀椾綅绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
- public AjaxResult<Void> add(@Validated @RequestBody SysPost post) {
+ public R<Void> add(@Validated @RequestBody SysPost post) {
if (UserConstants.NOT_UNIQUE.equals(postService.checkPostNameUnique(post))) {
- return AjaxResult.error("鏂板宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶅悕绉板凡瀛樺湪");
+ return R.fail("鏂板宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶅悕绉板凡瀛樺湪");
} else if (UserConstants.NOT_UNIQUE.equals(postService.checkPostCodeUnique(post))) {
- return AjaxResult.error("鏂板宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶇紪鐮佸凡瀛樺湪");
+ return R.fail("鏂板宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶇紪鐮佸凡瀛樺湪");
}
return toAjax(postService.insertPost(post));
}
@@ -83,15 +78,14 @@
/**
* 淇敼宀椾綅
*/
- @ApiOperation("淇敼宀椾綅")
@SaCheckPermission("system:post:edit")
@Log(title = "宀椾綅绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
- public AjaxResult<Void> edit(@Validated @RequestBody SysPost post) {
+ public R<Void> edit(@Validated @RequestBody SysPost post) {
if (UserConstants.NOT_UNIQUE.equals(postService.checkPostNameUnique(post))) {
- return AjaxResult.error("淇敼宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶅悕绉板凡瀛樺湪");
+ return R.fail("淇敼宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶅悕绉板凡瀛樺湪");
} else if (UserConstants.NOT_UNIQUE.equals(postService.checkPostCodeUnique(post))) {
- return AjaxResult.error("淇敼宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶇紪鐮佸凡瀛樺湪");
+ return R.fail("淇敼宀椾綅'" + post.getPostName() + "'澶辫触锛屽矖浣嶇紪鐮佸凡瀛樺湪");
}
return toAjax(postService.updatePost(post));
}
@@ -99,21 +93,19 @@
/**
* 鍒犻櫎宀椾綅
*/
- @ApiOperation("鍒犻櫎宀椾綅")
@SaCheckPermission("system:post:remove")
@Log(title = "宀椾綅绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{postIds}")
- public AjaxResult<Void> remove(@ApiParam("宀椾綅ID涓�") @PathVariable Long[] postIds) {
+ public R<Void> remove(@Parameter(name = "宀椾綅ID涓�") @PathVariable Long[] postIds) {
return toAjax(postService.deletePostByIds(postIds));
}
/**
* 鑾峰彇宀椾綅閫夋嫨妗嗗垪琛�
*/
- @ApiOperation("鑾峰彇宀椾綅閫夋嫨妗嗗垪琛�")
@GetMapping("/optionselect")
- public AjaxResult<List<SysPost>> optionselect() {
+ public R<List<SysPost>> optionselect() {
List<SysPost> posts = postService.selectPostAll();
- return AjaxResult.success(posts);
+ return R.ok(posts);
}
}
--
Gitblit v1.9.3