From 8d76107c273d5a8cd464d1bc62638ae2127ea1d7 Mon Sep 17 00:00:00 2001 From: huk Date: Fri, 19 Sep 2025 17:32:27 +0800 Subject: [PATCH] =?UTF-8?q?refactor(ruoyi):=20=E6=9B=B4=E6=96=B0=20API=20?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=B3=A8=E8=A7=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit -替换 @Tag 为 @Operation 注解 - 更新 API 接口的 summary 描述 -移除冗余代码和不必要的注释 - 统一使用 io.swagger.v3 包 --- .../org/dromara/app/AppArticleController.java | 3 +- .../org/dromara/app/AppCommentController.java | 22 +++------- .../org/dromara/app/AppDictController.java | 15 +++---- .../dromara/app/AppFeedbackController.java | 31 +++---------- .../org/dromara/app/AppMemberController.java | 21 +++++---- .../org/dromara/app/AppPayController.java | 16 +++---- .../org/dromara/app/AppProductController.java | 7 +-- .../org/dromara/app/AppSearchController.java | 3 +- .../org/dromara/app/AppTenantController.java | 3 +- .../org/dromara/app/AppVersionController.java | 3 +- .../org/dromara/app/AppVlogController.java | 34 ++++++++------- .../app/customer/AppOrderController.java | 35 +++++---------- .../controller/ArticleCategoryController.java | 21 ++++----- .../content/controller/ArticleController.java | 21 ++++----- .../content/controller/VlogController.java | 39 ++++++++--------- .../controller/admin/CommentController.java | 30 ++++--------- .../admin/VlogUploadController.java | 31 ++++++------- .../goods/controller/BrandController.java | 20 ++++----- .../controller/ProductCategoryController.java | 17 ++++---- .../goods/controller/SkuController.java | 14 +++--- .../resources/mapper/goods/ProductMapper.xml | 6 ++- .../im/controller/IMMessageController.java | 26 ++++------- .../IMMessageTemplateController.java | 43 +++++++------------ .../controller/IMMessageUserController.java | 31 +++++-------- .../member/controller/FansController.java | 32 +++++++------- .../member/controller/FeedbackController.java | 14 +++--- .../controller/MemberAccountController.java | 19 ++++---- .../controller/MemberAddressController.java | 15 ++++--- .../controller/MemberBankController.java | 17 ++++---- .../controller/MemberCartController.java | 14 +++--- .../controller/MemberForbiddenController.java | 18 ++++---- .../controller/MemberLoginInfoController.java | 26 +++++------ .../controller/TenantForbiddenController.java | 22 +++++----- .../order/controller/AftersaleController.java | 24 ++++++----- .../controller/AftersaleItemController.java | 19 ++++---- .../OrderDeliveryHistoryController.java | 19 ++++---- .../order/controller/OrderItemController.java | 23 +++++----- .../OrderOperateHistoryController.java | 23 +++++----- .../order/controller/RedPacketController.java | 13 +++--- .../VerificationCodeController.java | 9 ++-- .../WechatPaymentHistoryController.java | 26 ++++++----- .../GoodsStatisticsManagerController.java | 12 +++--- .../IndexStatisticsManagerController.java | 15 ++++--- .../MemberStatisticsManagerController.java | 7 +-- .../OrderStatisticsManagerController.java | 17 ++++---- ...efundOrderStatisticsManagerController.java | 9 ++-- .../ViewStatisticsManagerController.java | 15 ++++--- .../CommissionSectionController.java | 2 +- 48 files changed, 420 insertions(+), 482 deletions(-) diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppArticleController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppArticleController.java index 1a5e1472a..994dd2e97 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppArticleController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppArticleController.java @@ -3,6 +3,7 @@ package org.dromara.app; import com.wzj.soopin.content.domain.bo.ArticleBO; import com.wzj.soopin.content.domain.vo.ArticleVO; import com.wzj.soopin.content.service.IArticleService; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; @@ -20,7 +21,7 @@ import java.util.List; public class AppArticleController { private final IArticleService service; - @Tag(name = "轮播列表") + @Operation(summary = "轮播列表") @PostMapping("/carousel") public R> carousel(@RequestBody ArticleBO bo) { bo.setType(1);//轮播图 diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppCommentController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppCommentController.java index 5e3cdd2ba..aca62d0e6 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppCommentController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppCommentController.java @@ -1,24 +1,16 @@ package org.dromara.app; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; -import com.wzj.soopin.content.domain.base.BaseInfoProperties; import com.wzj.soopin.content.domain.bo.CommentBO; import com.wzj.soopin.content.domain.po.Comment; import com.wzj.soopin.content.domain.vo.CommentVO; -import com.wzj.soopin.content.enums.MessageEnum; import com.wzj.soopin.content.service.CommentService; -import com.wzj.soopin.content.service.MsgService; -import com.wzj.soopin.content.utils.RedisOperator; -import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.extern.slf4j.Slf4j; import org.dromara.common.core.domain.R; -import org.dromara.common.mq.domain.MQMessage; -import org.dromara.common.mq.enums.MQMessageType; -import org.dromara.common.mq.enums.MessageActionEnum; -import org.dromara.common.mq.utils.MqUtil; -import org.dromara.common.redis.redis.RedisCache; import org.dromara.common.satoken.utils.LoginHelper; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.*; @@ -27,14 +19,14 @@ import java.util.HashMap; import java.util.List; import java.util.Map; @Slf4j -@Api(tags = "管理端-评论管理接口") +@Tag(name = "管理端-评论管理接口") @RequestMapping("/app/comment") @RestController public class AppCommentController { @Autowired private CommentService commentService; - @ApiOperation("查询视频评论列表") + @Operation(summary = "查询视频评论列表") @PostMapping("/page") public R> queryVlogComments( @RequestBody CommentBO bo, @@ -48,7 +40,7 @@ public class AppCommentController { } } - @ApiOperation("发布评论") + @Operation(summary = "发布评论") @PostMapping("/publish") public R publishComment(@RequestBody CommentBO bo) { try { @@ -60,7 +52,7 @@ public class AppCommentController { } } - @ApiOperation("删除评论") + @Operation(summary = "删除评论") @PostMapping("/delete") public R deleteComment( @ApiParam(value = "评论ID") @RequestParam String commentId) { @@ -74,7 +66,7 @@ public class AppCommentController { } } - @ApiOperation("获取评论详情") + @Operation(summary = "获取评论详情") @GetMapping("/detail") public R> getCommentDetail(@ApiParam(value = "评论ID") @RequestParam String commentId) { try { diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppDictController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppDictController.java index e516b0840..ce9d38b61 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppDictController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppDictController.java @@ -1,27 +1,25 @@ package org.dromara.app; import cn.hutool.core.util.ObjectUtil; -import com.wzj.soopin.member.convert.FeedbackConvert; -import com.wzj.soopin.member.domain.bo.FeedbackBO; -import com.wzj.soopin.member.service.IFeedbackService; -import io.swagger.annotations.Api; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.AllArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.dromara.common.core.domain.R; -import org.dromara.common.log.annotation.Log; -import org.dromara.common.log.enums.BusinessType; import org.dromara.system.domain.vo.SysDictDataVo; import org.dromara.system.service.ISysDictDataService; import org.dromara.system.service.ISysDictTypeService; -import org.springframework.web.bind.annotation.*; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; import java.util.ArrayList; import java.util.List; @Slf4j -@Api(tags = "VlogController 短视频相关业务功能的接口") +@Tag(name = "字典数据接口") @RequestMapping("/app/sys/dict") @RestController @AllArgsConstructor @@ -34,6 +32,7 @@ public class AppDictController { * * @param dictType 字典类型 */ + @Operation(summary = "根据字典类型查询字典数据信息") @GetMapping(value = "/type/{dictType}") public R> dictType(@PathVariable String dictType) { List data = dictTypeService.selectDictDataByTypeWithDefaultTenantID(dictType); diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppFeedbackController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppFeedbackController.java index f82244c90..eb1af6e5d 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppFeedbackController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppFeedbackController.java @@ -1,40 +1,23 @@ package org.dromara.app; -import com.baomidou.mybatisplus.extension.plugins.pagination.Page; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.wzj.soopin.content.domain.bo.*; -import com.wzj.soopin.content.domain.po.Vlog; -import com.wzj.soopin.content.domain.vo.IndexVlogVO; -import com.wzj.soopin.content.service.VlogService; -import com.wzj.soopin.content.service.VlogUploadService; -import com.wzj.soopin.content.utils.QcCloud; -import com.wzj.soopin.content.utils.RedisOperator; import com.wzj.soopin.member.convert.FeedbackConvert; import com.wzj.soopin.member.domain.bo.FeedbackBO; import com.wzj.soopin.member.service.IFeedbackService; -import io.swagger.annotations.Api; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.AllArgsConstructor; import lombok.extern.slf4j.Slf4j; -import org.apache.commons.lang3.StringUtils; import org.dromara.common.core.domain.R; -import org.dromara.common.core.domain.model.LoginUser; -import org.dromara.common.core.exception.ServiceException; import org.dromara.common.log.annotation.Log; import org.dromara.common.log.enums.BusinessType; -import org.dromara.common.satoken.utils.LoginHelper; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.web.bind.annotation.*; - -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -import static com.wzj.soopin.content.domain.base.BaseInfoProperties.*; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; @Slf4j -@Api(tags = "VlogController 短视频相关业务功能的接口") +@Tag(name = "意见反馈") @RequestMapping("/app/feedback") @RestController @AllArgsConstructor @@ -42,7 +25,7 @@ public class AppFeedbackController { private final IFeedbackService service; private final FeedbackConvert convert; - @Tag(name = "修改意见反馈备注信息") + @Operation(summary = "修改意见反馈备注信息") @Log(title = "新增意见反馈", businessType = BusinessType.UPDATE) @PostMapping("/add") public R add(@RequestBody FeedbackBO feedback) { diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppMemberController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppMemberController.java index 5ba03f2ad..3ca5335e5 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppMemberController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppMemberController.java @@ -17,7 +17,6 @@ import com.wzj.soopin.member.domain.vo.AccountBillVO; import com.wzj.soopin.member.domain.vo.MemberAccountVO; import com.wzj.soopin.member.domain.vo.MemberBankVO; import com.wzj.soopin.member.domain.vo.MemberVO; -import com.wzj.soopin.transaction.service.IAccountBillService; import com.wzj.soopin.member.service.IMemberAccountService; import com.wzj.soopin.member.service.IMemberBankService; import com.wzj.soopin.member.service.IMemberService; @@ -26,8 +25,10 @@ import com.wzj.soopin.transaction.convert.WithdrawConvert; import com.wzj.soopin.transaction.domain.bo.ChargeBO; import com.wzj.soopin.transaction.domain.bo.WithdrawBO; import com.wzj.soopin.transaction.enums.WithdrawType; +import com.wzj.soopin.transaction.service.IAccountBillService; import com.wzj.soopin.transaction.service.IChargeService; import com.wzj.soopin.transaction.service.IWithdrawService; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import me.zhyd.oauth.model.AuthResponse; @@ -45,8 +46,6 @@ import org.dromara.common.social.config.properties.SocialProperties; import org.dromara.common.social.utils.SocialUtils; import org.springframework.web.bind.annotation.*; -import java.time.LocalDateTime; - @RestController @RequestMapping("/app/member") @Tag(name = "会员管理") @@ -75,7 +74,7 @@ public class AppMemberController { private final IWithdrawService withdrawService; private final WithdrawConvert withdrawConvert; - @Tag(name = "获取会员账户信息详细信息") + @Operation(summary = "获取会员账户信息详细信息") @GetMapping(value = "/info") public R getInfo(Long memberId) { //获取用户信息 @@ -89,7 +88,7 @@ public class AppMemberController { return R.ok(service.getMemberInfo(memberId)); } - @Tag(name = "获取会员账户表详细信息") + @Operation(summary = "获取会员账户表详细信息") @GetMapping(value = "/account") public R accountInfo() { //获取用户信息 @@ -100,7 +99,7 @@ public class AppMemberController { return R.ok(accountConvert.toVO(accountService.getMemberAccount(loginUser.getUserId()))); } - @Tag(name = "查询账单") + @Operation(summary = "查询账单") @PostMapping("/bank") public R> list(@RequestBody MemberBankBO bo, @RequestBody Page page) { @@ -115,7 +114,7 @@ public class AppMemberController { return R.ok(memberBankConvert.toVO(memberPage)); } - @Tag(name = "查询账单") + @Operation(summary = "查询账单") @PostMapping("/bills") public R> list(@RequestBody AccountBillBO bo, @RequestBody Page page) { @@ -136,7 +135,7 @@ public class AppMemberController { } - @Tag(name = "绑定推广人") + @Operation(summary = "绑定推广人") @PostMapping("/bind/spread") public R bindSpread(@RequestBody MemberBO bo) { @@ -144,7 +143,7 @@ public class AppMemberController { return R.ok(); } - @Tag(name = "绑定微信") + @Operation(summary = "绑定微信") @PostMapping("/bind/wechat") public R bindWechat(@RequestBody SocialLoginBody loginBody) { @@ -173,7 +172,7 @@ public class AppMemberController { return R.ok(authUserData.getToken()); } - @Tag(name = "充值") + @Operation(summary = "充值") @Log(title = "新增 ", businessType = BusinessType.INSERT) @PostMapping("/charge") public R charge(@RequestBody ChargeBO bo) { @@ -188,7 +187,7 @@ public class AppMemberController { return R.ok(chargeService.charge(chargeConvert.toPo(bo))); } - @Tag(name = "提现") + @Operation(summary = "提现") @Log(title = "提现 ", businessType = BusinessType.INSERT) @PostMapping("/withdraw") public R withdraw(@RequestBody WithdrawBO bo) { diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppPayController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppPayController.java index f0fec3a6d..4de8b9323 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppPayController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppPayController.java @@ -5,10 +5,11 @@ import com.wzj.soopin.transaction.enums.PaymentMethodEnum; import com.wzj.soopin.transaction.kit.CashierSupport; import com.wzj.soopin.transaction.kit.dto.PayParam; import com.wzj.soopin.transaction.kit.params.dto.CashierParam; -import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import lombok.RequiredArgsConstructor; @@ -28,7 +29,7 @@ import org.springframework.web.bind.annotation.*; */ @Slf4j @RestController -@Api(tags = "买家端,收银台接口") +@Tag(name = "收银台接口") @RequestMapping("/app/payment") @RequiredArgsConstructor public class AppPayController { @@ -41,7 +42,7 @@ public class AppPayController { // @ApiImplicitParam(name = "client", value = "客户端类型", paramType = "path", allowableValues = "PC,H5,WECHAT_MP,APP") // }) @PostMapping(value = "/tradeDetail") - @ApiOperation(value = "获取支付详情") + @Operation(summary = "获取支付详情") public R paymentParams(@RequestBody @Validated PayParam payParam) { CashierParam cashierParam = cashierSupport.cashierParam(payParam); @@ -53,9 +54,8 @@ public class AppPayController { @ApiImplicitParam(name = "paymentMethod", value = "支付方式", paramType = "path", allowableValues = "WECHAT,ALIPAY"), @ApiImplicitParam(name = "paymentClient", value = "调起方式", paramType = "path", allowableValues = "APP,NATIVE,JSAPI,H5,MP") }) - @PostMapping(value = "/pay") - @ApiOperation(value = "支付") + @Operation(summary = "支付") public R payment( HttpServletRequest request, HttpServletResponse response, @@ -76,7 +76,7 @@ public class AppPayController { } - @ApiOperation(value = "支付回调") + @Operation(summary = "支付回调") @RequestMapping(value = "/callback/{paymentMethod}", method = {RequestMethod.GET, RequestMethod.POST}) public R callback(HttpServletRequest request, @PathVariable String paymentMethod) { @@ -87,7 +87,7 @@ public class AppPayController { return R.ok(ResultCode.PAY_SUCCESS); } - @ApiOperation(value = "支付异步通知") + @Operation(summary = "支付异步通知") @RequestMapping(value = "/notify/{paymentMethod}", method = {RequestMethod.GET, RequestMethod.POST}) public void notify(HttpServletRequest request, @PathVariable String paymentMethod) { @@ -97,7 +97,7 @@ public class AppPayController { } - @ApiOperation(value = "查询支付结果") + @Operation(summary = "查询支付结果") @GetMapping(value = "/result") public R paymentResult(PayParam payParam) { return R.ok(cashierSupport.paymentResult(payParam)); diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppProductController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppProductController.java index 00030e17c..446415baf 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppProductController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppProductController.java @@ -8,12 +8,13 @@ import com.wzj.soopin.goods.domain.entity.Product; import com.wzj.soopin.goods.domain.vo.ProductVO; import com.wzj.soopin.goods.service.ProductService; import com.wzj.soopin.goods.service.impl.ProductServiceImpl; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; import org.springframework.web.bind.annotation.*; -@Tag(name ="商品信息接口列表") +@Tag(name ="商品") @RestController @RequestMapping("/app/product") @RequiredArgsConstructor @@ -23,14 +24,14 @@ public class AppProductController { private final ProductConvert convert; private final ProductService productService; - @Tag(name = "查询商品信息列表") + @Operation(summary = "查询商品信息列表") @PostMapping("page") public R> page(@RequestBody ProductBo query, Page page) { IPage resultPage = service.getProduct(page, query); return R.ok(resultPage); } - @Tag(name ="获取商品信息详细信息") + @Operation(summary = "获取商品信息详细信息") @GetMapping(value = "/{id}") public R getInfo(@PathVariable("id") Long id) { return R.ok(service.selectById(id)); diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppSearchController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppSearchController.java index e2beca2a4..5a73ead20 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppSearchController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppSearchController.java @@ -9,6 +9,7 @@ import com.wzj.soopin.goods.domain.bo.ProductBo; import com.wzj.soopin.goods.service.ProductService; import com.wzj.soopin.member.domain.bo.MemberBO; import com.wzj.soopin.member.service.IMemberService; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -34,7 +35,7 @@ public class AppSearchController { private final IMemberService memberService; private final VlogService vlogService; - @Tag(name = "视频、商品和用户检索") + @Operation(summary = "视频、商品和用户检索") @PostMapping("") public R> search(@RequestBody SearchBO searchBO, @RequestBody Page page) { try { diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppTenantController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppTenantController.java index 4c2b40941..646d6cd9f 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppTenantController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppTenantController.java @@ -4,6 +4,7 @@ import com.wzj.soopin.transaction.convert.WithdrawConvert; import com.wzj.soopin.transaction.domain.bo.WithdrawBO; import com.wzj.soopin.transaction.enums.WithdrawType; import com.wzj.soopin.transaction.service.IWithdrawService; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; @@ -25,7 +26,7 @@ public class AppTenantController { private final IWithdrawService withdrawService; private final WithdrawConvert withdrawConvert; - @Tag(name = "提现") + @Operation(summary = "提现") @Log(title = "提现 ", businessType = BusinessType.INSERT) @PostMapping("/withdraw") public R withdraw(@RequestBody WithdrawBO bo) { diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppVersionController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppVersionController.java index feef243be..776f1e4d0 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppVersionController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppVersionController.java @@ -2,6 +2,7 @@ package org.dromara.app; import com.baomidou.mybatisplus.core.metadata.IPage; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; @@ -24,7 +25,7 @@ public class AppVersionController { private final ISysVerisonService sysVerisonService; - @Tag(name ="查询app版本管理") + @Operation(summary = "查询app版本管理") @PostMapping("/page") public R> list(@RequestBody SysVersionBo query, Page page){ return R.ok(sysVerisonService.getList(page,query)); diff --git a/ruoyi-admin/src/main/java/org/dromara/app/AppVlogController.java b/ruoyi-admin/src/main/java/org/dromara/app/AppVlogController.java index 6a501345f..9b79e6d6c 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/AppVlogController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/AppVlogController.java @@ -8,19 +8,17 @@ import com.wzj.soopin.content.service.VlogService; import com.wzj.soopin.content.service.VlogUploadService; import com.wzj.soopin.content.utils.QcCloud; import io.swagger.annotations.Api; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.AllArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.dromara.common.core.domain.R; import org.dromara.common.core.domain.model.LoginUser; import org.dromara.common.core.exception.ServiceException; -import org.dromara.common.mq.domain.MQMessage; import org.dromara.common.redis.redis.RedisCache; import org.dromara.common.satoken.utils.LoginHelper; import org.springframework.web.bind.annotation.*; -import java.time.LocalDateTime; - @Slf4j @Api(tags = "VlogController 短视频相关业务功能的接口") @@ -35,7 +33,7 @@ public class AppVlogController { private final IVlogPullService pullService; - @Tag(name = "首页视频列表") + @Operation(summary = "首页视频列表") @PostMapping("/indexList") public R> indexList(@RequestBody IndexListBO bo, @RequestBody Page page) { @@ -43,6 +41,7 @@ public class AppVlogController { return R.ok(pages); } + @Operation(summary = "视频详情") @GetMapping("/detail/{vlogId}") public R detail(@PathVariable String vlogId) { @@ -50,7 +49,7 @@ public class AppVlogController { } - @Tag(name = "我的私密视频列表") + @Operation(summary = "我的私密视频列表") @PostMapping("/myPrivateList") public R> myPrivateList(@RequestBody MyListBO bo, @RequestBody Page page) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -62,7 +61,7 @@ public class AppVlogController { return R.ok(pages); } - @Tag(name = "我点赞的视频列表") + @Operation(summary = "我点赞的视频列表") @PostMapping("/myLikedList") public R> myLikedList(@RequestBody MyLikedVlogBO bo, @RequestBody Page page) { @@ -70,7 +69,7 @@ public class AppVlogController { return R.ok(pages); } - @Tag(name = "我关注的人的视频列表") + @Operation(summary = "我关注人的视频列表") @PostMapping("/followList") public R> followList(@RequestBody SimpleListBO bo, @RequestBody Page page) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -82,7 +81,7 @@ public class AppVlogController { return R.ok(pages); } - @Tag(name = "好友视频列表") + @Operation(summary = "好友视频列表") @PostMapping("/friendList") public R> friendList(@RequestBody SimpleListBO bo, @RequestBody Page page) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -94,25 +93,22 @@ public class AppVlogController { return R.ok(pages); } - /** - * 上传视频到云点播 - * @param vlogBO - * @return - * @throws Exception - */ + + @Operation(summary = "上传视频到云点播") @PostMapping("publish") public R publish(@RequestBody VlogBO vlogBO) throws Exception { vlogService.createVlog(vlogBO); return R.ok(); } - @Tag(name = "我的公开视频列表") + @Operation(summary = "我的公开视频列表") @PostMapping("/myPublicList") public R> myPublicList(@RequestBody MyListBO bo, @RequestBody Page page) { Page pages = vlogService.queryMyVlogList(bo, page); return R.ok(pages); } + @Operation(summary = "点赞") @PostMapping("/like") public R like(@RequestBody VlogBO vlogBO) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -128,6 +124,7 @@ public class AppVlogController { + @Operation(summary = "取消点赞") @PostMapping("/unlike") public R unlike(@RequestBody VlogBO vlogBO) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -139,6 +136,8 @@ public class AppVlogController { vlogService.userUnLikeVlog(userId, vlogId); return R.ok(); } + + @Operation(summary = "已读视频") @GetMapping("/read") public R read(@RequestBody VlogBO vlogBO) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -148,6 +147,7 @@ public class AppVlogController { vlogService.readVlog(loginUser.getUserId(), vlogBO.getId()); return R.ok(); } + @Operation(summary = "删除视频") @DeleteMapping("/delete/{id}") public R delete(@PathVariable String id) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -157,6 +157,8 @@ public class AppVlogController { vlogService.removeById(id); return R.ok(); } + + @Operation(summary = "视频列表") @PostMapping("/page") public R> page(@RequestBody VlogBO vlogBO) { LoginUser loginUser = LoginHelper.getLoginUser(); @@ -168,7 +170,7 @@ public class AppVlogController { } - @Tag(name = "手动触发缓存点赞最多视频") + @Operation(summary = "手动触发缓存点赞最多视频") @PostMapping("/cacheTopLikedVlogs") public R cacheTopLikedVlogs(@RequestParam(defaultValue = "100") int limit) { try { diff --git a/ruoyi-admin/src/main/java/org/dromara/app/customer/AppOrderController.java b/ruoyi-admin/src/main/java/org/dromara/app/customer/AppOrderController.java index cf34d2e45..80b1ae269 100644 --- a/ruoyi-admin/src/main/java/org/dromara/app/customer/AppOrderController.java +++ b/ruoyi-admin/src/main/java/org/dromara/app/customer/AppOrderController.java @@ -1,18 +1,15 @@ package org.dromara.app.customer; import com.baomidou.mybatisplus.core.metadata.IPage; -import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import com.wzj.soopin.content.utils.RedisOperator; import com.wzj.soopin.order.business.IOrderBusiness; import com.wzj.soopin.order.domain.bo.OrderBo; import com.wzj.soopin.order.domain.bo.SaveOrderBO; -import com.wzj.soopin.order.domain.entity.Order; -import com.wzj.soopin.order.domain.vo.ManagerOrderDetailVO; import com.wzj.soopin.order.domain.vo.OrderVO; import com.wzj.soopin.order.service.IMemberOrderService; import com.wzj.soopin.order.service.OrderService; import com.wzj.soopin.order.service.VerificationCodeService; -import io.swagger.annotations.Api; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -25,7 +22,7 @@ import org.springframework.web.bind.annotation.*; @Slf4j -@Api(tags = "订单相关接口") +@Tag(name = "订单") @RequestMapping("/app/order") @RestController @RequiredArgsConstructor @@ -39,7 +36,8 @@ public class AppOrderController { private final IOrderBusiness orderBusiness; public RedisOperator redis; - @Tag(name ="查询订单列表") + + @Operation(summary = "查询订单列表") @PostMapping("/page") public R> page(@RequestBody OrderBo bo){ LoginUser loginUser= LoginHelper.getLoginUser(); @@ -48,32 +46,23 @@ public class AppOrderController { return R.ok(memberOrderService.page(bo)); } - /** - * 获取订单详细信息 - * @param id 订单id - * @return - */ + + @Operation(summary = "获取订单详细信息") @GetMapping(value = "/{id}") public R getInfo(@PathVariable("id") Long id) { return R.ok(orderBusiness.info(id)); } - /** - * 生成订单 - * @param saveOrderBO - * @return - */ + + @Operation(summary = "生成订单") @Log(title = "生成订单", businessType = BusinessType.INSERT) @PostMapping("/add") public R add(@RequestBody SaveOrderBO saveOrderBO) { return R.ok(orderService.saveOrder(saveOrderBO)); } - /** - * 取消订单 - * @param orderId - * @return - */ + + @Operation(summary = "取消订单") @Log(title = "取消订单", businessType = BusinessType.UPDATE) @PostMapping("/cancel/{orderId}") public R cancel(@PathVariable("orderId") Long orderId) { @@ -83,9 +72,7 @@ public class AppOrderController { - /** - * 生成核销码 - */ + @Operation(summary = "生成核销码") @GetMapping("/generate/{orderId}") @Tag(name = "生成核销码") public R generateCode(@PathVariable Long orderId) { diff --git a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleCategoryController.java b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleCategoryController.java index be6a47c41..294bff5e4 100644 --- a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleCategoryController.java +++ b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleCategoryController.java @@ -3,16 +3,11 @@ package com.wzj.soopin.content.controller; import com.baomidou.mybatisplus.core.metadata.IPage; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import com.wzj.soopin.content.convert.ArticleCategoryConvert; -import com.wzj.soopin.content.convert.ArticleConvert; -import com.wzj.soopin.content.domain.bo.ArticleBO; import com.wzj.soopin.content.domain.bo.ArticleCategoryBO; -import com.wzj.soopin.content.domain.po.Article; import com.wzj.soopin.content.domain.po.ArticleCategory; import com.wzj.soopin.content.domain.vo.ArticleCategoryVO; -import com.wzj.soopin.content.domain.vo.ArticleVO; import com.wzj.soopin.content.service.IArticleCategoryService; -import com.wzj.soopin.content.service.IArticleService; -import com.wzj.soopin.member.domain.bo.TenantForbiddenBO; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; @@ -34,40 +29,40 @@ public class ArticleCategoryController { private final IArticleCategoryService service; private final ArticleCategoryConvert convert; - @Tag(name = "查询列表") + @Operation(summary = "查询列表") @PostMapping("/page") public R> page(@RequestBody ArticleCategoryBO bo, @RequestBody Page page) { Page pages = service.page(page, bo.toWrapper()); return R.ok(convert.toVO(pages)); } - @Tag(name = "查询列表") + @Operation(summary = "查询列表") @PostMapping("/list") public R< List> list(@RequestBody ArticleCategoryBO bo, @RequestBody Page page) { List articleList = service.list( bo.toWrapper()); return R.ok(convert.toVO(articleList)); } - @Tag(name = "查询列表") + @Operation(summary = "查询树形列表") @PostMapping("/tree") public R< List> tree(@RequestBody ArticleCategoryBO bo ) { List articleList = service.tree( bo.toWrapper()); return R.ok( articleList); } - @Tag(name = "新增") + @Operation(summary = "新增") @Log(title = "新增 ", businessType = BusinessType.INSERT) @PostMapping("/add") public R add(@RequestBody ArticleCategoryBO bo) { return R.ok(service.save(convert.toPo(bo))); } - @Tag(name = "详情") + @Operation(summary = "详情") @GetMapping(value = "/{id}") public R getInfo(@PathVariable("id") Long id) { return R.ok(convert.toVO(service.getById(id))); } - @Tag(name = ("处理")) + @Operation(summary = "修改") @Log(title = "修改", businessType = BusinessType.UPDATE) @PostMapping("/update") public R update(@RequestBody ArticleCategoryBO bo) { @@ -76,7 +71,7 @@ public class ArticleCategoryController { } - @Tag(name = "删除") + @Operation(summary = "删除") @Log(title = "删除", businessType = BusinessType.DELETE) @DeleteMapping("/{id}") public R remove(@PathVariable Long id) { diff --git a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleController.java b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleController.java index f3826d7c3..592c43912 100644 --- a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleController.java +++ b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/ArticleController.java @@ -6,13 +6,8 @@ import com.wzj.soopin.content.convert.ArticleConvert; import com.wzj.soopin.content.domain.bo.ArticleBO; import com.wzj.soopin.content.domain.po.Article; import com.wzj.soopin.content.domain.vo.ArticleVO; -import com.wzj.soopin.content.service.IArticleCategoryService; import com.wzj.soopin.content.service.IArticleService; -import com.wzj.soopin.member.convert.TenantForbiddenConvert; -import com.wzj.soopin.member.domain.bo.TenantForbiddenBO; -import com.wzj.soopin.member.domain.po.TenantForbidden; -import com.wzj.soopin.member.domain.vo.TenantForbiddenVO; -import com.wzj.soopin.member.service.ITenantForbiddenService; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; @@ -34,34 +29,34 @@ public class ArticleController { private final IArticleService service; private final ArticleConvert convert; - @Tag(name = "查询列表") + @Operation(summary = "分页查询") @PostMapping("/page") public R> page(@RequestBody ArticleBO bo, @RequestBody Page page) { Page
pages = service.page(page, bo.toWrapper()); return R.ok(convert.toVO(pages)); } - @Tag(name = "查询列表") + @Operation(summary = "查询列表") @PostMapping("/list") public R< List> list(@RequestBody ArticleBO bo, @RequestBody Page page) { List articleList = service.selectVoList( bo.toWrapper()); return R.ok(articleList); } - @Tag(name = "新增") + @Operation(summary = "新增") @Log(title = "新增 ", businessType = BusinessType.INSERT) @PostMapping("/add") public R add(@RequestBody ArticleBO bo) { return R.ok(service.save(convert.toPo(bo))); } - @Tag(name = "详情") + @Operation(summary = "详情") @GetMapping(value = "/{id}") public R getInfo(@PathVariable("id") Long id) { return R.ok(convert.toVO(service.getById(id))); } - @Tag(name = ("处理")) + @Operation(summary = "修改") @Log(title = "修改", businessType = BusinessType.UPDATE) @PostMapping("/update") public R update(@RequestBody ArticleBO bo) { @@ -70,7 +65,7 @@ public class ArticleController { } - @Tag(name = "删除") + @Operation(summary = "删除") @Log(title = "删除", businessType = BusinessType.DELETE) @DeleteMapping("/{id}") public R remove(@PathVariable Long id) { @@ -78,7 +73,7 @@ public class ArticleController { } - @Tag(name = "轮播列表") + @Operation(summary = "轮播列表") @PostMapping("/carousel") public R< List> carousel(@RequestBody ArticleBO bo, @RequestBody Page page) { bo.setType(1);//轮播图 diff --git a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/VlogController.java b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/VlogController.java index 3b2ab98b5..68fae27bd 100644 --- a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/VlogController.java +++ b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/VlogController.java @@ -1,41 +1,28 @@ package com.wzj.soopin.content.controller; - +import com.baomidou.mybatisplus.core.metadata.IPage; +import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import com.wzj.soopin.content.domain.base.BaseInfoProperties; -import com.wzj.soopin.content.domain.bo.*; -import com.wzj.soopin.content.domain.po.Article; -import com.wzj.soopin.content.domain.vo.ArticleVO; +import com.wzj.soopin.content.domain.bo.VlogBO; import com.wzj.soopin.content.domain.vo.IndexVlogVO; import com.wzj.soopin.content.enums.YesOrNo; import com.wzj.soopin.content.service.IVlogPullService; import com.wzj.soopin.content.service.IVlogPushService; -import lombok.AllArgsConstructor; -import org.dromara.common.core.domain.R; import com.wzj.soopin.content.service.VlogService; -import com.wzj.soopin.content.service.VlogUploadService; -import com.wzj.soopin.content.utils.PagedGridResult; -import com.wzj.soopin.content.utils.QcCloud; -import io.swagger.annotations.Api; -import io.swagger.annotations.ApiOperation; -import lombok.extern.slf4j.Slf4j; -import org.apache.commons.lang3.StringUtils; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; import com.wzj.soopin.content.utils.RedisOperator; -import com.baomidou.mybatisplus.core.metadata.IPage; -import com.baomidou.mybatisplus.extension.plugins.pagination.Page; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; -import com.fasterxml.jackson.databind.ObjectMapper; - +import lombok.AllArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.dromara.common.core.domain.R; import org.springframework.web.bind.annotation.*; import java.util.List; import java.util.Map; -import java.util.ArrayList; @Slf4j -@Api(tags = "VlogController 短视频相关业务功能的接口") +@Tag(name = "短视频相关业务功能的接口") @RequestMapping("/cms/vlog") @RestController @AllArgsConstructor @@ -44,7 +31,8 @@ public class VlogController extends BaseInfoProperties { public final RedisOperator redis; private final IVlogPushService vlogPushService; private final IVlogPullService vlogPullService; - @Tag(name = "查询列表") + + @Operation(summary = "查询列表") @PostMapping("/page") public R> page(@RequestBody VlogBO bo, @RequestBody Page page) { Page pages = vlogService.getIndexVlogList(bo ,page); @@ -164,6 +152,7 @@ public class VlogController extends BaseInfoProperties { + @Operation(summary = "修改视频状态") @PostMapping("/changeVlogStatus") public R changeVlogStatus(@RequestParam String userId, @RequestParam String vlogId, @@ -172,6 +161,7 @@ public class VlogController extends BaseInfoProperties { return R.ok(); } + @Operation(summary = "修改视频为私密") @PostMapping("/changeToPrivate") public R changeToPrivate(@RequestParam String userId, @RequestParam String vlogId) { @@ -181,6 +171,7 @@ public class VlogController extends BaseInfoProperties { return R.ok(); } + @Operation(summary = "修改视频为公开") @PostMapping("/changeToPublic") public R changeToPublic(@RequestParam String userId, @RequestParam String vlogId) { @@ -190,15 +181,19 @@ public class VlogController extends BaseInfoProperties { return R.ok(); } + @Operation(summary = "查询视频被点赞数量") @PostMapping("/totalLikedCounts") public R totalLikedCounts(@RequestParam String vlogId) { return R.ok(vlogService.getVlogBeLikedCounts(vlogId)); } + + @Operation(summary = "推送视频") @GetMapping("/push") public R pushMember(@RequestParam int count,@RequestParam String tag) { return R.ok(vlogPushService.pushVlogToMq(count,tag)); } + @Operation(summary = "同步视频") @GetMapping("/sync") public R syncVlog() { // vlogPullService.pullFromTencentCloud(); diff --git a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/CommentController.java b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/CommentController.java index b4ac60e4c..b420ba7a0 100644 --- a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/CommentController.java +++ b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/CommentController.java @@ -3,36 +3,24 @@ package com.wzj.soopin.content.controller.admin; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import com.wzj.soopin.content.domain.bo.CommentBO; import com.wzj.soopin.content.domain.po.Comment; -import com.wzj.soopin.content.domain.vo.CommentVO; import com.wzj.soopin.content.domain.vo.ChildCommentVO; - +import com.wzj.soopin.content.domain.vo.CommentVO; import com.wzj.soopin.content.service.CommentService; -// import com.wzj.soopin.content.utils.PagedGridResult; -import io.swagger.annotations.Api; +import com.wzj.soopin.content.service.MsgService; +import com.wzj.soopin.content.utils.RedisOperator; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.extern.slf4j.Slf4j; import org.dromara.common.core.domain.R; -// import org.dromara.common.mybatis.core.page.PageQuery; -// import org.dromara.common.mybatis.core.page.TableDataInfo; import org.dromara.common.satoken.utils.LoginHelper; import org.dromara.common.web.core.BaseController; -// import org.dromara.common.core.constant.HttpStatus; - import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.*; -import java.util.List; -import java.util.Map; -import java.util.HashMap; -import com.wzj.soopin.content.utils.RedisOperator; -import com.wzj.soopin.content.service.MsgService; -import com.wzj.soopin.content.domain.base.BaseInfoProperties; -import com.wzj.soopin.content.enums.MessageEnum; -// import com.wzj.soopin.content.domain.po.Comment; - @Slf4j -@Api(tags = "管理端-评论管理接口") +@Tag(name = "管理端-评论管理接口") @RequestMapping("/cms/comment") @RestController public class CommentController extends BaseController { @@ -46,7 +34,7 @@ public class CommentController extends BaseController { @Autowired private MsgService msgService; - @ApiOperation("获取评论列表") + @Operation(summary = "获取评论列表") @PostMapping("/list") public R> list( @RequestBody CommentBO bo, @@ -60,7 +48,7 @@ public class CommentController extends BaseController { - @ApiOperation("获取子评论列表") + @Operation(summary = "获取子评论列表") @GetMapping("/childList") public R> getChildComments( @RequestParam String fatherCommentId, @@ -71,7 +59,7 @@ public class CommentController extends BaseController { return R.ok(page); } - @ApiOperation("下架评论") + @Operation(summary = "下架评论") @PostMapping("/offline") public R offlineComment(@ApiParam(value = "评论ID") @RequestParam String commentId) { try { diff --git a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/VlogUploadController.java b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/VlogUploadController.java index 8ca0dd728..48f5caf1f 100644 --- a/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/VlogUploadController.java +++ b/ruoyi-modules/ruoyi-content/src/main/java/com/wzj/soopin/content/controller/admin/VlogUploadController.java @@ -1,26 +1,23 @@ package com.wzj.soopin.content.controller.admin; -import com.baomidou.mybatisplus.core.metadata.IPage; -import com.baomidou.mybatisplus.extension.plugins.pagination.Page; -import com.tencentcloudapi.vod.v20180717.models.*; import com.wzj.soopin.content.domain.base.BaseInfoProperties; -import com.wzj.soopin.content.domain.bo.VlogBO; - import com.wzj.soopin.content.service.VlogService; import com.wzj.soopin.content.service.VlogUploadService; import com.wzj.soopin.content.utils.RedisOperator; -import org.dromara.common.redis.utils.RedisUtils; import com.wzj.soopin.content.utils.TencentCloudUtil; import com.wzj.soopin.member.service.IFansService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; +import io.swagger.v3.oas.annotations.Operation; import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.StringUtils; import org.dromara.common.core.domain.R; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.*; -import org.apache.commons.lang3.StringUtils; -import java.util.*; +import java.util.Collections; +import java.util.List; +import java.util.Map; @Slf4j @Api(tags = "管理端-视频") @@ -43,9 +40,8 @@ public class VlogUploadController extends BaseInfoProperties { @Autowired private IFansService fansService; - /** - * 视频审核接口 - */ + + @Operation(summary = "视频审核接口") @PostMapping("/audit") public R auditVlog(@RequestParam String vlogId, @RequestParam Integer status, @@ -59,9 +55,8 @@ public class VlogUploadController extends BaseInfoProperties { } } - /** - * 视频删除接口 - */ + + @Operation(summary = "视频删除接口") @PostMapping("/delete") public R deleteVlog(@RequestParam String vlogId) { try { @@ -73,9 +68,7 @@ public class VlogUploadController extends BaseInfoProperties { } } - /** - * 视频详情接口 - */ + @Operation(summary = "视频详情接口") @GetMapping("/detail") public R> vlogDetail(@RequestParam String fileId) { try { @@ -96,7 +89,7 @@ public class VlogUploadController extends BaseInfoProperties { } } - @ApiOperation(value = "禁播/解禁视频", notes = "禁播/解禁视频接口") + @Operation(summary = "视频禁播/解禁接口") @PostMapping("/forbid") public R forbidMediaDistribution(@RequestBody Map params) { try { @@ -148,7 +141,7 @@ public class VlogUploadController extends BaseInfoProperties { } } - @ApiOperation(value = "根据vlogerId查询用户信息", notes = "查询视频上传者的姓名和电话") + @Operation(summary = "根据vlogerId查询用户信息") @GetMapping("/user-info") public R> getUserInfoByVlogerId(@RequestParam String vlogerId) { try { diff --git a/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/BrandController.java b/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/BrandController.java index d4733da28..7fc2709dc 100644 --- a/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/BrandController.java +++ b/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/BrandController.java @@ -4,12 +4,10 @@ package com.wzj.soopin.goods.controller; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import com.wzj.soopin.goods.convert.BrandConvert; import com.wzj.soopin.goods.domain.bo.BrandBo; -import com.wzj.soopin.goods.domain.bo.ProductCategoryBo; import com.wzj.soopin.goods.domain.entity.Brand; -import com.wzj.soopin.goods.domain.entity.ProductCategory; import com.wzj.soopin.goods.domain.vo.BrandVO; -import com.wzj.soopin.goods.domain.vo.ProductCategoryVO; import com.wzj.soopin.goods.service.impl.BrandServiceImpl; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; @@ -26,7 +24,7 @@ import java.util.List; * @author zcc * @date 2022-11-28 */ -@Tag(name ="品牌管理接口列表") +@Tag(name ="品牌管理") @RestController @RequestMapping("/pms/brand") @RequiredArgsConstructor @@ -36,14 +34,14 @@ public class BrandController extends BaseController { private final BrandConvert convert; - @Tag(name ="所有品牌管理列表") + @Operation(summary = "所有品牌管理列表") @PostMapping("list") public R> list(@RequestBody BrandBo query, Page page) { Page brandPage = service.page(page,query.toWrapper()); return R.ok(convert.toVO(brandPage)); } - @Tag(name ="所有品牌管理列表") + @Operation(summary = "所有品牌管理列表") @PostMapping("page") public R> list(@RequestBody BrandBo query) { List productCategoryList = service.list(query.toWrapper()); @@ -51,7 +49,7 @@ public class BrandController extends BaseController { } - @Tag(name ="导出品牌管理列表") + @Operation(summary = "导出品牌管理列表") @Log(title = "品牌管理", businessType = BusinessType.EXPORT) @PostMapping("export") public R export(BrandBo query) { @@ -61,27 +59,27 @@ public class BrandController extends BaseController { } - @Tag(name ="获取品牌管理详细信息") + @Operation(summary = "获取品牌管理详细信息") @GetMapping(value = "/{id}") public R getInfo(@PathVariable("id") Long id) { return R.ok(service.getById(id)); } - @Tag(name ="新增品牌管理") + @Operation(summary = "新增品牌管理") @Log(title = "品牌管理", businessType = BusinessType.INSERT) @PostMapping("/add") public R add(@RequestBody Brand brand) { return R.ok(service.save(brand)); } - @Tag(name ="修改品牌管理") + @Operation(summary = "修改品牌管理") @Log(title = "品牌管理", businessType = BusinessType.UPDATE) @PostMapping("/update") public R edit(@RequestBody Brand brand) { return R.ok(service.updateById(brand)); } - @Tag(name ="删除品牌管理") + @Operation(summary = "删除品牌管理") @Log(title = "品牌管理", businessType = BusinessType.DELETE) @DeleteMapping("/{id}") public R remove(@PathVariable Long id) { diff --git a/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/ProductCategoryController.java b/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/ProductCategoryController.java index a25ab2541..dfd6eab0d 100644 --- a/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/ProductCategoryController.java +++ b/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/ProductCategoryController.java @@ -7,6 +7,7 @@ import com.wzj.soopin.goods.domain.bo.ProductCategoryBo; import com.wzj.soopin.goods.domain.entity.ProductCategory; import com.wzj.soopin.goods.domain.vo.ProductCategoryVO; import com.wzj.soopin.goods.service.impl.ProductCategoryServiceImpl; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; @@ -24,7 +25,7 @@ import java.util.List; * @author zcc * @date 2022-11-28 */ -@Tag(name ="商品分类接口列表") +@Tag(name ="商品分类") @RestController @RequestMapping("/pms/product/category") @RequiredArgsConstructor @@ -35,46 +36,46 @@ public class ProductCategoryController extends BaseController { private final ProductCategoryServiceImpl service; private final ProductCategoryConvert convert; - @Tag(name = "查询列表") + @Operation(summary = "查询列表") @PostMapping("/tree") public R< List> tree(@RequestBody ProductCategoryBo bo ) { List articleList = service.tree( bo.toWrapper()); return R.ok( articleList); } - @Tag(name = "查询列表") + @Operation(summary = "查询列表") @PostMapping("/page") public R> page(@RequestBody ProductCategoryBo bo, @RequestBody Page page) { Page pages = service.page(page, bo.toWrapper()); return R.ok(convert.toVO(pages)); } - @Tag(name ="查询商品分类列表") + @Operation(summary = "查询商品分类列表") @PostMapping("list") public R> list(@RequestBody ProductCategoryBo query) { List productCategoryList = service.list(query.toWrapper()); return R.ok(convert.toVO(productCategoryList)); } - @Tag(name ="获取商品分类详细信息") + @Operation(summary = "获取商品分类详细信息") @GetMapping(value = "/{id}") public R getInfo(@PathVariable("id") Long id) { return R.ok(service.getById(id)); } - @Tag(name ="获取商品分类详细信息") + @Operation(summary = "获取商品分类详细信息") @Log(title = "商品分类", businessType = BusinessType.INSERT) @PostMapping("/add") public R add(@RequestBody ProductCategory productCategory) { return R.ok(service.save(productCategory)); } - @Tag(name ="修改商品分类") + @Operation(summary = "修改商品分类") @Log(title = "商品分类", businessType = BusinessType.UPDATE) @PostMapping("/update") public R edit(@RequestBody ProductCategory productCategory) { return R.ok(service.updateById(productCategory)); } - @Tag(name ="删除商品分类") + @Operation(summary = "删除商品分类") @Log(title = "商品分类", businessType = BusinessType.DELETE) @DeleteMapping("/{id}") public R remove(@PathVariable Long id) { diff --git a/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/SkuController.java b/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/SkuController.java index 409164e24..f99f63dfb 100644 --- a/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/SkuController.java +++ b/ruoyi-modules/ruoyi-goods/src/main/java/com/wzj/soopin/goods/controller/SkuController.java @@ -7,13 +7,13 @@ import com.wzj.soopin.goods.domain.bo.SkuBo; import com.wzj.soopin.goods.domain.entity.Sku; import com.wzj.soopin.goods.domain.vo.SkuVO; import com.wzj.soopin.goods.service.impl.SkuServiceImpl; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.dromara.common.core.domain.R; import org.dromara.common.excel.utils.ExcelUtil; import org.dromara.common.log.annotation.Log; import org.dromara.common.log.enums.BusinessType; -import org.dromara.common.satoken.utils.LoginHelper; import org.dromara.common.web.core.BaseController; import org.springframework.web.bind.annotation.*; @@ -33,13 +33,13 @@ public class SkuController extends BaseController { private final SkuServiceImpl service; private final SkuConvert convert; - @Tag(name ="查询商品信息列表") + @Operation(summary = "查询商品信息列表") @PostMapping("list") public R> list(@RequestBody SkuBo query, Page page) { return R.ok(service.getList(query,page)); } - @Tag(name ="导出sku信息列表") + @Operation(summary = "导出sku信息列表") @Log(title = "sku信息", businessType = BusinessType.EXPORT) @PostMapping("export") public R export(SkuBo query) { @@ -48,13 +48,13 @@ public class SkuController extends BaseController { return R.ok(util.writeExcel(convert.toVO(list), "sku信息数据")); } - @Tag(name ="获取sku信息详细信息") + @Operation(summary = "获取sku信息详细信息") @GetMapping(value = "/{id}") public R getInfo(@PathVariable("id") Long id) { return R.ok(service.selectSkuByid(id)); } - @Tag(name ="新增sku信息") + @Operation(summary = "新增sku信息") @Log(title = "sku信息", businessType = BusinessType.INSERT) @PostMapping("/add") public R add(@RequestBody Sku sku) { @@ -62,14 +62,14 @@ public class SkuController extends BaseController { return R.ok(); } - @Tag(name ="修改sku信息") + @Operation(summary = "修改sku信息") @Log(title = "sku信息", businessType = BusinessType.UPDATE) @PostMapping("/update") public R edit(@RequestBody Sku sku) { return R.ok(service.updateById(sku)); } - @Tag(name ="删除sku信息") + @Operation(summary = "删除sku信息") @Log(title = "sku信息", businessType = BusinessType.DELETE) @DeleteMapping("/{id}") public R remove(@PathVariable Long id) { diff --git a/ruoyi-modules/ruoyi-goods/src/main/resources/mapper/goods/ProductMapper.xml b/ruoyi-modules/ruoyi-goods/src/main/resources/mapper/goods/ProductMapper.xml index 1eb130f0a..cfea728f2 100644 --- a/ruoyi-modules/ruoyi-goods/src/main/resources/mapper/goods/ProductMapper.xml +++ b/ruoyi-modules/ruoyi-goods/src/main/resources/mapper/goods/ProductMapper.xml @@ -61,6 +61,7 @@ PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"