fix: knife4j框架版本4接口协议springdoc表单参数添加@ParameterObject注解

This commit is contained in:
haoxr
2023-02-22 10:46:27 +08:00
parent f49ba52554
commit b95d8fc29c
6 changed files with 20 additions and 6 deletions

View File

@@ -11,6 +11,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
import jakarta.validation.Valid; import jakarta.validation.Valid;
@@ -32,7 +33,9 @@ public class SysDeptController {
@Operation(summary = "获取部门列表") @Operation(summary = "获取部门列表")
@GetMapping @GetMapping
public Result<List<DeptVO>> listDepartments(DeptQuery queryParams) { public Result<List<DeptVO>> listDepartments(
@ParameterObject DeptQuery queryParams
) {
List<DeptVO> list = deptService.listDepartments(queryParams); List<DeptVO> list = deptService.listDepartments(queryParams);
return Result.success(list); return Result.success(list);
} }

View File

@@ -12,6 +12,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
@Tag(name = "字典数据接口") @Tag(name = "字典数据接口")
@@ -25,7 +26,7 @@ public class SysDictItemController {
@Operation(summary = "字典数据分页列表") @Operation(summary = "字典数据分页列表")
@GetMapping("/pages") @GetMapping("/pages")
public PageResult<DictItemPageVO> listDictItemPages( public PageResult<DictItemPageVO> listDictItemPages(
DictItemPageQuery queryParams @ParameterObject DictItemPageQuery queryParams
) { ) {
Page<DictItemPageVO> result = dictItemService.listDictItemPages(queryParams); Page<DictItemPageVO> result = dictItemService.listDictItemPages(queryParams);
return PageResult.success(result); return PageResult.success(result);

View File

@@ -13,6 +13,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
@@ -27,7 +28,9 @@ public class SysDictTypeController {
@Operation(summary = "字典类型分页列表") @Operation(summary = "字典类型分页列表")
@GetMapping("/pages") @GetMapping("/pages")
public PageResult<DictTypePageVO> listDictTypePages(DictTypePageQuery queryParams) { public PageResult<DictTypePageVO> listDictTypePages(
@ParameterObject DictTypePageQuery queryParams
) {
Page<DictTypePageVO> result = dictTypeService.listDictTypePages(queryParams); Page<DictTypePageVO> result = dictTypeService.listDictTypePages(queryParams);
return PageResult.success(result); return PageResult.success(result);
} }

View File

@@ -14,6 +14,7 @@ import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.cache.annotation.CacheEvict; import org.springframework.cache.annotation.CacheEvict;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
@@ -44,7 +45,7 @@ public class SysMenuController {
@Operation(summary = "菜单列表") @Operation(summary = "菜单列表")
@GetMapping @GetMapping
public Result listMenus(MenuQuery queryParams) { public Result listMenus( @ParameterObject MenuQuery queryParams) {
List<MenuVO> menuList = menuService.listMenus(queryParams); List<MenuVO> menuList = menuService.listMenus(queryParams);
return Result.success(menuList); return Result.success(menuList);
} }

View File

@@ -14,6 +14,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
import jakarta.validation.Valid; import jakarta.validation.Valid;
@@ -29,7 +30,9 @@ public class SysRoleController {
@Operation(summary = "角色分页列表") @Operation(summary = "角色分页列表")
@GetMapping("/pages") @GetMapping("/pages")
public PageResult<RolePageVO> listRolePages(RolePageQuery queryParams) { public PageResult<RolePageVO> listRolePages(
@ParameterObject RolePageQuery queryParams
) {
Page<RolePageVO> result = roleService.listRolePages(queryParams); Page<RolePageVO> result = roleService.listRolePages(queryParams);
return PageResult.success(result); return PageResult.success(result);
} }

View File

@@ -19,6 +19,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.validation.annotation.Validated; import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
@@ -48,7 +49,9 @@ public class SysUserController {
@Operation(summary = "用户分页列表") @Operation(summary = "用户分页列表")
@GetMapping("/pages") @GetMapping("/pages")
public PageResult<UserVO> listUserPages(UserPageQuery queryParams) { public PageResult<UserVO> listUserPages(
@ParameterObject UserPageQuery queryParams
) {
IPage<UserVO> result = userService.listUserPages(queryParams); IPage<UserVO> result = userService.listUserPages(queryParams);
return PageResult.success(result); return PageResult.success(result);
} }