From 8210b1f1ca88e9b52738a694f9795799dbf0438e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=98=BF=E6=B2=90?= Date: Sun, 15 Jan 2023 20:08:11 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A7=A3=E5=86=B3swagger=E6=8E=A5=E5=8F=A3?= =?UTF-8?q?=E6=96=87=E6=A1=A3=EF=BC=8C=E4=B8=8D=E8=83=BD=E6=9F=A5=E8=AF=A2?= =?UTF-8?q?=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../maku/message/controller/SmsLogController.java | 20 ++++++++++------- .../message/controller/SmsPlatformController.java | 3 ++- .../quartz/controller/ScheduleJobController.java | 3 ++- .../controller/ScheduleJobLogController.java | 15 +++++++------ .../system/controller/SysAttachmentController.java | 3 ++- .../system/controller/SysDictDataController.java | 15 +++++++------ .../system/controller/SysDictTypeController.java | 3 ++- .../system/controller/SysLogLoginController.java | 3 ++- .../system/controller/SysParamsController.java | 3 ++- .../maku/system/controller/SysPostController.java | 25 +++++++++++----------- .../maku/system/controller/SysRoleController.java | 3 ++- .../maku/system/controller/SysUserController.java | 3 ++- 12 files changed, 57 insertions(+), 42 deletions(-) diff --git a/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsLogController.java b/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsLogController.java index 309a4e8..3b643c6 100644 --- a/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsLogController.java +++ b/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsLogController.java @@ -10,19 +10,23 @@ import net.maku.message.entity.SmsLogEntity; import net.maku.message.query.SmsLogQuery; import net.maku.message.service.SmsLogService; import net.maku.message.vo.SmsLogVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; -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 javax.validation.Valid; /** -* 短信日志 -* -* @author 阿沐 babamu@126.com -*/ + * 短信日志 + * + * @author 阿沐 babamu@126.com + */ @RestController @RequestMapping("message/sms/log") -@Tag(name="短信日志") +@Tag(name = "短信日志") @AllArgsConstructor public class SmsLogController { private final SmsLogService smsLogService; @@ -30,7 +34,7 @@ public class SmsLogController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sms:log')") - public Result> page(@Valid SmsLogQuery query){ + public Result> page(@ParameterObject @Valid SmsLogQuery query) { PageResult page = smsLogService.page(query); return Result.ok(page); @@ -39,7 +43,7 @@ public class SmsLogController { @GetMapping("{id}") @Operation(summary = "信息") @PreAuthorize("hasAuthority('sms:log')") - public Result get(@PathVariable("id") Long id){ + public Result get(@PathVariable("id") Long id) { SmsLogEntity entity = smsLogService.getById(id); return Result.ok(SmsLogConvert.INSTANCE.convert(entity)); diff --git a/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsPlatformController.java b/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsPlatformController.java index 2a32079..8264eb9 100644 --- a/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsPlatformController.java +++ b/maku-boot-module/maku-module-message/src/main/java/net/maku/message/controller/SmsPlatformController.java @@ -16,6 +16,7 @@ import net.maku.message.sms.service.SmsService; import net.maku.message.vo.SmsPlatformVO; import net.maku.message.vo.SmsSendVO; import org.apache.commons.lang3.StringUtils; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; @@ -40,7 +41,7 @@ public class SmsPlatformController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sms:platform:page')") - public Result> page(@Valid SmsPlatformQuery query) { + public Result> page(@ParameterObject @Valid SmsPlatformQuery query) { PageResult page = smsPlatformService.page(query); return Result.ok(page); diff --git a/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobController.java b/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobController.java index 71e6eb5..f99c2f5 100644 --- a/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobController.java +++ b/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobController.java @@ -14,6 +14,7 @@ import net.maku.quartz.query.ScheduleJobQuery; import net.maku.quartz.service.ScheduleJobService; import net.maku.quartz.utils.CronUtils; import net.maku.quartz.vo.ScheduleJobVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Service; import org.springframework.web.bind.annotation.*; @@ -36,7 +37,7 @@ public class ScheduleJobController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('schedule:page')") - public Result> page(@Valid ScheduleJobQuery query) { + public Result> page(@ParameterObject @Valid ScheduleJobQuery query) { PageResult page = scheduleJobService.page(query); return Result.ok(page); diff --git a/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobLogController.java b/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobLogController.java index 09ee49f..52d75d7 100644 --- a/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobLogController.java +++ b/maku-boot-module/maku-module-quartz/src/main/java/net/maku/quartz/controller/ScheduleJobLogController.java @@ -10,6 +10,7 @@ import net.maku.quartz.entity.ScheduleJobLogEntity; import net.maku.quartz.query.ScheduleJobLogQuery; import net.maku.quartz.service.ScheduleJobLogService; import net.maku.quartz.vo.ScheduleJobLogVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; @@ -19,13 +20,13 @@ import org.springframework.web.bind.annotation.RestController; import javax.validation.Valid; /** -* 定时任务日志 -* -* @author 阿沐 babamu@126.com -*/ + * 定时任务日志 + * + * @author 阿沐 babamu@126.com + */ @RestController @RequestMapping("schedule/log") -@Tag(name="定时任务日志") +@Tag(name = "定时任务日志") @AllArgsConstructor public class ScheduleJobLogController { private final ScheduleJobLogService scheduleJobLogService; @@ -33,7 +34,7 @@ public class ScheduleJobLogController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('schedule:log')") - public Result> page(@Valid ScheduleJobLogQuery query){ + public Result> page(@ParameterObject @Valid ScheduleJobLogQuery query) { PageResult page = scheduleJobLogService.page(query); return Result.ok(page); @@ -42,7 +43,7 @@ public class ScheduleJobLogController { @GetMapping("{id}") @Operation(summary = "信息") @PreAuthorize("hasAuthority('schedule:log')") - public Result get(@PathVariable("id") Long id){ + public Result get(@PathVariable("id") Long id) { ScheduleJobLogEntity entity = scheduleJobLogService.getById(id); return Result.ok(ScheduleJobLogConvert.INSTANCE.convert(entity)); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysAttachmentController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysAttachmentController.java index 67f17a3..fe3fa47 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysAttachmentController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysAttachmentController.java @@ -8,6 +8,7 @@ import net.maku.framework.common.utils.Result; import net.maku.system.query.SysAttachmentQuery; import net.maku.system.service.SysAttachmentService; import net.maku.system.vo.SysAttachmentVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; @@ -29,7 +30,7 @@ public class SysAttachmentController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:attachment:page')") - public Result> page(@Valid SysAttachmentQuery query) { + public Result> page(@ParameterObject @Valid SysAttachmentQuery query) { PageResult page = sysAttachmentService.page(query); return Result.ok(page); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysDictDataController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysDictDataController.java index 41d8fda..d792369 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysDictDataController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysDictDataController.java @@ -7,9 +7,10 @@ import net.maku.framework.common.page.PageResult; import net.maku.framework.common.utils.Result; import net.maku.system.convert.SysDictDataConvert; import net.maku.system.entity.SysDictDataEntity; -import net.maku.system.service.SysDictDataService; import net.maku.system.query.SysDictDataQuery; +import net.maku.system.service.SysDictDataService; import net.maku.system.vo.SysDictDataVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; @@ -23,7 +24,7 @@ import java.util.List; */ @RestController @RequestMapping("sys/dict/data") -@Tag(name="字典数据") +@Tag(name = "字典数据") @AllArgsConstructor public class SysDictDataController { private final SysDictDataService sysDictDataService; @@ -31,7 +32,7 @@ public class SysDictDataController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:dict:page')") - public Result> page(@Valid SysDictDataQuery query){ + public Result> page(@ParameterObject @Valid SysDictDataQuery query) { PageResult page = sysDictDataService.page(query); return Result.ok(page); @@ -40,7 +41,7 @@ public class SysDictDataController { @GetMapping("{id}") @Operation(summary = "信息") @PreAuthorize("hasAuthority('sys:dict:info')") - public Result get(@PathVariable("id") Long id){ + public Result get(@PathVariable("id") Long id) { SysDictDataEntity entity = sysDictDataService.getById(id); return Result.ok(SysDictDataConvert.INSTANCE.convert(entity)); @@ -49,7 +50,7 @@ public class SysDictDataController { @PostMapping @Operation(summary = "保存") @PreAuthorize("hasAuthority('sys:dict:save')") - public Result save(@RequestBody @Valid SysDictDataVO vo){ + public Result save(@RequestBody @Valid SysDictDataVO vo) { sysDictDataService.save(vo); return Result.ok(); @@ -58,7 +59,7 @@ public class SysDictDataController { @PutMapping @Operation(summary = "修改") @PreAuthorize("hasAuthority('sys:dict:update')") - public Result update(@RequestBody @Valid SysDictDataVO vo){ + public Result update(@RequestBody @Valid SysDictDataVO vo) { sysDictDataService.update(vo); return Result.ok(); @@ -67,7 +68,7 @@ public class SysDictDataController { @DeleteMapping @Operation(summary = "删除") @PreAuthorize("hasAuthority('sys:dict:delete')") - public Result delete(@RequestBody List idList){ + public Result delete(@RequestBody List idList) { sysDictDataService.delete(idList); return Result.ok(); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysDictTypeController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysDictTypeController.java index 7d62e23..9ac68f4 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysDictTypeController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysDictTypeController.java @@ -11,6 +11,7 @@ import net.maku.system.query.SysDictTypeQuery; import net.maku.system.service.SysDictTypeService; import net.maku.system.vo.SysDictTypeVO; import net.maku.system.vo.SysDictVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; @@ -32,7 +33,7 @@ public class SysDictTypeController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:dict:page')") - public Result> page(@Valid SysDictTypeQuery query) { + public Result> page(@ParameterObject @Valid SysDictTypeQuery query) { PageResult page = sysDictTypeService.page(query); return Result.ok(page); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysLogLoginController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysLogLoginController.java index 507bba4..2eb6d3a 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysLogLoginController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysLogLoginController.java @@ -8,6 +8,7 @@ import net.maku.framework.common.utils.Result; import net.maku.system.query.SysLogLoginQuery; import net.maku.system.service.SysLogLoginService; import net.maku.system.vo.SysLogLoginVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; @@ -30,7 +31,7 @@ public class SysLogLoginController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:log:login')") - public Result> page(@Valid SysLogLoginQuery query) { + public Result> page(@ParameterObject @Valid SysLogLoginQuery query) { PageResult page = sysLogLoginService.page(query); return Result.ok(page); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysParamsController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysParamsController.java index 7c7adc1..294530c 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysParamsController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysParamsController.java @@ -10,6 +10,7 @@ import net.maku.system.entity.SysParamsEntity; import net.maku.system.query.SysParamsQuery; import net.maku.system.service.SysParamsService; import net.maku.system.vo.SysParamsVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; @@ -31,7 +32,7 @@ public class SysParamsController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:params:all')") - public Result> page(@Valid SysParamsQuery query) { + public Result> page(@ParameterObject @Valid SysParamsQuery query) { PageResult page = sysParamsService.page(query); return Result.ok(page); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysPostController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysPostController.java index 6164c5f..01c1aa6 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysPostController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysPostController.java @@ -7,9 +7,10 @@ import net.maku.framework.common.page.PageResult; import net.maku.framework.common.utils.Result; import net.maku.system.convert.SysPostConvert; import net.maku.system.entity.SysPostEntity; -import net.maku.system.service.SysPostService; import net.maku.system.query.SysPostQuery; +import net.maku.system.service.SysPostService; import net.maku.system.vo.SysPostVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; @@ -18,13 +19,13 @@ import java.util.List; /** -* 岗位管理 -* -* @author 阿沐 babamu@126.com -*/ + * 岗位管理 + * + * @author 阿沐 babamu@126.com + */ @RestController @RequestMapping("sys/post") -@Tag(name="岗位管理") +@Tag(name = "岗位管理") @AllArgsConstructor public class SysPostController { private final SysPostService sysPostService; @@ -32,7 +33,7 @@ public class SysPostController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:post:page')") - public Result> page(@Valid SysPostQuery query){ + public Result> page(@ParameterObject @Valid SysPostQuery query) { PageResult page = sysPostService.page(query); return Result.ok(page); @@ -40,7 +41,7 @@ public class SysPostController { @GetMapping("list") @Operation(summary = "列表") - public Result> list(){ + public Result> list() { List list = sysPostService.getList(); return Result.ok(list); @@ -49,7 +50,7 @@ public class SysPostController { @GetMapping("{id}") @Operation(summary = "信息") @PreAuthorize("hasAuthority('sys:post:info')") - public Result get(@PathVariable("id") Long id){ + public Result get(@PathVariable("id") Long id) { SysPostEntity entity = sysPostService.getById(id); return Result.ok(SysPostConvert.INSTANCE.convert(entity)); @@ -58,7 +59,7 @@ public class SysPostController { @PostMapping @Operation(summary = "保存") @PreAuthorize("hasAuthority('sys:post:save')") - public Result save(@RequestBody SysPostVO vo){ + public Result save(@RequestBody SysPostVO vo) { sysPostService.save(vo); return Result.ok(); @@ -67,7 +68,7 @@ public class SysPostController { @PutMapping @Operation(summary = "修改") @PreAuthorize("hasAuthority('sys:post:update')") - public Result update(@RequestBody @Valid SysPostVO vo){ + public Result update(@RequestBody @Valid SysPostVO vo) { sysPostService.update(vo); return Result.ok(); @@ -76,7 +77,7 @@ public class SysPostController { @DeleteMapping @Operation(summary = "删除") @PreAuthorize("hasAuthority('sys:post:delete')") - public Result delete(@RequestBody List idList){ + public Result delete(@RequestBody List idList) { sysPostService.delete(idList); return Result.ok(); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysRoleController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysRoleController.java index bdd4329..134e0a4 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysRoleController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysRoleController.java @@ -16,6 +16,7 @@ import net.maku.system.vo.SysMenuVO; import net.maku.system.vo.SysRoleDataScopeVO; import net.maku.system.vo.SysRoleVO; import net.maku.system.vo.SysUserVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; @@ -42,7 +43,7 @@ public class SysRoleController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:role:page')") - public Result> page(@Valid SysRoleQuery query) { + public Result> page(@ParameterObject @Valid SysRoleQuery query) { PageResult page = sysRoleService.page(query); return Result.ok(page); diff --git a/maku-boot-system/src/main/java/net/maku/system/controller/SysUserController.java b/maku-boot-system/src/main/java/net/maku/system/controller/SysUserController.java index eda4c6f..139edae 100644 --- a/maku-boot-system/src/main/java/net/maku/system/controller/SysUserController.java +++ b/maku-boot-system/src/main/java/net/maku/system/controller/SysUserController.java @@ -16,6 +16,7 @@ import net.maku.system.service.SysUserRoleService; import net.maku.system.service.SysUserService; import net.maku.system.vo.SysUserPasswordVO; import net.maku.system.vo.SysUserVO; +import org.springdoc.api.annotations.ParameterObject; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.security.crypto.password.PasswordEncoder; import org.springframework.web.bind.annotation.*; @@ -43,7 +44,7 @@ public class SysUserController { @GetMapping("page") @Operation(summary = "分页") @PreAuthorize("hasAuthority('sys:user:page')") - public Result> page(@Valid SysUserQuery query) { + public Result> page(@ParameterObject @Valid SysUserQuery query) { PageResult page = sysUserService.page(query); return Result.ok(page);