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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java

@@ -18,7 +18,6 @@
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
import com.ruoyi.system.service.SysPermissionService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
@@ -46,14 +45,12 @@
    private final ISysUserService userService;
    private final SysPermissionService permissionService;

    @Operation(summary = "查询角色信息列表")
    @SaCheckPermission("system:role:list")
    @GetMapping("/list")
    public TableDataInfo<SysRole> list(SysRole role, PageQuery pageQuery) {
        return roleService.selectPageRoleList(role, pageQuery);
    }

    @Operation(summary = "导出角色信息列表")
    @Log(title = "角色管理", businessType = BusinessType.EXPORT)
    @SaCheckPermission("system:role:export")
    @PostMapping("/export")
@@ -65,7 +62,6 @@
    /**
     * 根据角色编号获取详细信息
     */
    @Operation(summary = "根据角色编号获取详细信息")
    @SaCheckPermission("system:role:query")
    @GetMapping(value = "/{roleId}")
    public R<SysRole> getInfo(@Parameter(name = "角色ID") @PathVariable Long roleId) {
@@ -76,7 +72,6 @@
    /**
     * 新增角色
     */
    @Operation(summary = "新增角色")
    @SaCheckPermission("system:role:add")
    @Log(title = "角色管理", businessType = BusinessType.INSERT)
    @PostMapping
@@ -93,7 +88,6 @@
    /**
     * 修改保存角色
     */
    @Operation(summary = "修改保存角色")
    @SaCheckPermission("system:role:edit")
    @Log(title = "角色管理", businessType = BusinessType.UPDATE)
    @PutMapping
@@ -122,7 +116,6 @@
    /**
     * 修改保存数据权限
     */
    @Operation(summary = "修改保存数据权限")
    @SaCheckPermission("system:role:edit")
    @Log(title = "角色管理", businessType = BusinessType.UPDATE)
    @PutMapping("/dataScope")
@@ -135,7 +128,6 @@
    /**
     * 状态修改
     */
    @Operation(summary = "状态修改")
    @SaCheckPermission("system:role:edit")
    @Log(title = "角色管理", businessType = BusinessType.UPDATE)
    @PutMapping("/changeStatus")
@@ -148,7 +140,6 @@
    /**
     * 删除角色
     */
    @Operation(summary = "删除角色")
    @SaCheckPermission("system:role:remove")
    @Log(title = "角色管理", businessType = BusinessType.DELETE)
    @DeleteMapping("/{roleIds}")
@@ -159,7 +150,6 @@
    /**
     * 获取角色选择框列表
     */
    @Operation(summary = "获取角色选择框列表")
    @SaCheckPermission("system:role:query")
    @GetMapping("/optionselect")
    public R<List<SysRole>> optionselect() {
@@ -169,7 +159,6 @@
    /**
     * 查询已分配用户角色列表
     */
    @Operation(summary = "查询已分配用户角色列表")
    @SaCheckPermission("system:role:list")
    @GetMapping("/authUser/allocatedList")
    public TableDataInfo<SysUser> allocatedList(SysUser user, PageQuery pageQuery) {
@@ -179,7 +168,6 @@
    /**
     * 查询未分配用户角色列表
     */
    @Operation(summary = "查询未分配用户角色列表")
    @SaCheckPermission("system:role:list")
    @GetMapping("/authUser/unallocatedList")
    public TableDataInfo<SysUser> unallocatedList(SysUser user, PageQuery pageQuery) {
@@ -189,7 +177,6 @@
    /**
     * 取消授权用户
     */
    @Operation(summary = "取消授权用户")
    @SaCheckPermission("system:role:edit")
    @Log(title = "角色管理", businessType = BusinessType.GRANT)
    @PutMapping("/authUser/cancel")
@@ -200,7 +187,6 @@
    /**
     * 批量取消授权用户
     */
    @Operation(summary = "批量取消授权用户")
    @Parameters({
        @Parameter(name = "roleId", description = "角色ID", in = ParameterIn.QUERY),
        @Parameter(name = "userIds", description = "用户ID串", in = ParameterIn.QUERY)
@@ -215,7 +201,6 @@
    /**
     * 批量选择用户授权
     */
    @Operation(summary = "批量选择用户授权")
    @Parameters({
        @Parameter(name = "roleId", description = "角色ID", in = ParameterIn.QUERY),
        @Parameter(name = "userIds", description = "用户ID串", in = ParameterIn.QUERY)