add 整合 springdoc-openapi-javadoc 基于代码注释生成文档

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/PriorityQueueController.java

@@ -1,14 +1,12 @@
package com.ruoyi.demo.controller.queue;

import cn.hutool.core.util.RandomUtil;
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.QueueUtils;
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 lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@@ -25,15 +23,14 @@
 * @version 3.6.0
 */
@Slf4j
@Api(value = "优先队列 演示案例", tags = {"优先队列"})
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@Tag(name ="优先队列 演示案例", description = "优先队列")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/queue/priority")
public class PriorityQueueController {

    @ApiOperation("添加队列数据")
    @GetMapping("/add")
    public AjaxResult<Void> add(@ApiParam("队列名") String queueName) {
    public R<Void> add(@Parameter(name = "队列名") String queueName) {
        // 用完了一定要销毁 否则会一直存在
        boolean b = QueueUtils.destroyPriorityQueueObject(queueName);
        log.info("通道: {} , 删除: {}", queueName, b);
@@ -43,43 +40,45 @@
            log.info("通道: {} , 设置比较器成功", queueName);
        } else {
            log.info("通道: {} , 设置比较器失败", queueName);
            return AjaxResult.error("操作失败");
            return R.fail("操作失败");
        }
        for (int i = 0; i < 10; i++) {
            int randomNum = RandomUtil.randomInt(10);
            PriorityDemo data = new PriorityDemo().setName("data-" + i).setOrderNum(randomNum);
            PriorityDemo data = new PriorityDemo();
            data.setName("data-" + i);
            data.setOrderNum(randomNum);
            if (QueueUtils.addPriorityQueueObject(queueName, data)) {
                log.info("通道: {} , 发送数据: {}", queueName, data);
            } else {
                log.info("通道: {} , 发送数据: {}, 发送失败", queueName, data);
            }
        }
        return AjaxResult.success("操作成功");
        return R.ok("操作成功");
    }

    @ApiOperation("删除队列数据")
    @GetMapping("/remove")
    public AjaxResult<Void> remove(@ApiParam("队列名") String queueName,
                                   @ApiParam("对象名") String name,
                                   @ApiParam("排序号") Integer orderNum) {
        PriorityDemo data = new PriorityDemo().setName(name).setOrderNum(orderNum);
    public R<Void> remove(@Parameter(name = "队列名") String queueName,
                                   @Parameter(name = "对象名") String name,
                                   @Parameter(name = "排序号") Integer orderNum) {
        PriorityDemo data = new PriorityDemo();
        data.setName(name);
        data.setOrderNum(orderNum);
        if (QueueUtils.removePriorityQueueObject(queueName, data)) {
            log.info("通道: {} , 删除数据: {}", queueName, data);
        } else {
            return AjaxResult.error("操作失败");
            return R.fail("操作失败");
        }
        return AjaxResult.success("操作成功");
        return R.ok("操作成功");
    }

    @ApiOperation("获取队列数据")
    @GetMapping("/get")
    public AjaxResult<Void> get(@ApiParam("队列名") String queueName) {
    public R<Void> get(@Parameter(name = "队列名") String queueName) {
        PriorityDemo data;
        do {
            data = QueueUtils.getPriorityQueueObject(queueName);
            log.info("通道: {} , 获取数据: {}", queueName, data);
        } while (data != null);
        return AjaxResult.success("操作成功");
        return R.ok("操作成功");
    }

}