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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-system/src/main/java/com/ruoyi/system/domain/vo/RouterVo.java

@@ -1,7 +1,6 @@
package com.ruoyi.system.domain.vo;

import com.fasterxml.jackson.annotation.JsonInclude;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

import java.util.List;
@@ -13,61 +12,51 @@
 */
@Data
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@Schema(name = "路由配置信息")
public class RouterVo {

    /**
     * 路由名字
     */
    @Schema(name = "路由名字")
    private String name;

    /**
     * 路由地址
     */
    @Schema(name = "路由地址")
    private String path;

    /**
     * 是否隐藏路由，当设置 true 的时候该路由不会再侧边栏出现
     */
    @Schema(name = "是否隐藏路由，当设置 true 的时候该路由不会再侧边栏出现")
    private boolean hidden;

    /**
     * 重定向地址，当设置 noRedirect 的时候该路由在面包屑导航中不可被点击
     */
    @Schema(name = "重定向地址，当设置 noRedirect 的时候该路由在面包屑导航中不可被点击")
    private String redirect;

    /**
     * 组件地址
     */
    @Schema(name = "组件地址")
    private String component;

    /**
     * 路由参数：如 {"id": 1, "name": "ry"}
     */
    @Schema(name = "路由参数：如 {\"id\": 1, \"name\": \"ry\"}")
    private String query;

    /**
     * 当你一个路由下面的 children 声明的路由大于1个时，自动会变成嵌套的模式--如组件页面
     */
    @Schema(name = "当你一个路由下面的 children 声明的路由大于1个时，自动会变成嵌套的模式--如组件页面")
    private Boolean alwaysShow;

    /**
     * 其他元素
     */
    @Schema(name = "其他元素")
    private MetaVo meta;

    /**
     * 子路由
     */
    @Schema(name = "子路由")
    private List<RouterVo> children;

}