Add kdoc
This commit is contained in:
@@ -20,6 +20,7 @@ import top.fatweb.api.vo.api.v1.avatar.AvatarBase64Vo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see IAvatarService
|
||||
*/
|
||||
@Tag(name = "随机头像", description = "随机头像相关接口")
|
||||
@RequestMapping("/api/{apiVersion}/avatar")
|
||||
|
||||
@@ -22,6 +22,7 @@ import top.fatweb.api.vo.permission.TokenVo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see IAuthenticationService
|
||||
*/
|
||||
@Tag(name = "身份认证", description = "身份认证相关接口")
|
||||
@RestController
|
||||
|
||||
@@ -18,6 +18,7 @@ import top.fatweb.api.vo.permission.base.GroupVo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see IGroupService
|
||||
*/
|
||||
@Tag(name = "用户组管理", description = "用户组管理相关接口")
|
||||
@RequestMapping("/system/group")
|
||||
|
||||
@@ -15,6 +15,7 @@ import top.fatweb.api.vo.permission.PowerSetVo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see IPowerService
|
||||
*/
|
||||
@Tag(name = "权限管理", description = "权限管理相关接口")
|
||||
@RequestMapping("/system/power")
|
||||
|
||||
@@ -18,6 +18,7 @@ import top.fatweb.api.vo.permission.base.RoleVo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see IRoleService
|
||||
*/
|
||||
@Tag(name = "角色管理", description = "角色管理相关接口")
|
||||
@RequestMapping("/system/role")
|
||||
|
||||
@@ -20,6 +20,7 @@ import top.fatweb.api.vo.permission.UserWithRoleInfoVo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see IUserService
|
||||
*/
|
||||
@Tag(name = "用户管理", description = "用户管理相关接口")
|
||||
@RequestMapping("/system/user")
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
package top.fatweb.api.controller.system
|
||||
|
||||
import io.swagger.v3.oas.annotations.tags.Tag
|
||||
import org.springframework.web.bind.annotation.RequestMapping
|
||||
import org.springframework.web.bind.annotation.RestController
|
||||
|
||||
@Tag(name = "邮件接口", description = "邮件发送接口")
|
||||
@RequestMapping("/system/mail")
|
||||
@RestController
|
||||
class MailController {
|
||||
|
||||
}
|
||||
@@ -13,6 +13,7 @@ import top.fatweb.api.vo.system.SettingsVo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see ISettingsService
|
||||
*/
|
||||
@Tag(name = "系统设置", description = "系统设置相关接口")
|
||||
@RequestMapping("/system/settings")
|
||||
@@ -20,10 +21,29 @@ import top.fatweb.api.vo.system.SettingsVo
|
||||
class SettingsController(
|
||||
private val settingsService: ISettingsService
|
||||
) {
|
||||
/**
|
||||
* Get all settings
|
||||
*
|
||||
* @return Response object includes all settings
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see ResponseResult
|
||||
* @see SettingsVo
|
||||
*/
|
||||
@Operation(summary = "获取全部设置")
|
||||
@GetMapping
|
||||
fun get(): ResponseResult<SettingsVo> = ResponseResult.success(data = settingsService.get())
|
||||
|
||||
/**
|
||||
* Update mail settings
|
||||
*
|
||||
* @param mailSettingsParam Mail settings parameters
|
||||
* @return Response object
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see MailSettingsParam
|
||||
* @see ResponseResult
|
||||
*/
|
||||
@Operation(summary = "更新邮件设置")
|
||||
@PutMapping("/mail")
|
||||
fun updateMail(@RequestBody mailSettingsParam: MailSettingsParam): ResponseResult<Nothing> {
|
||||
|
||||
@@ -20,6 +20,7 @@ import top.fatweb.api.vo.system.SysLogVo
|
||||
*
|
||||
* @author FatttSnake, fatttsnake@gmail.com
|
||||
* @since 1.0.0
|
||||
* @see ISysLogService
|
||||
*/
|
||||
@Tag(name = "系统日志", description = "系统日志相关接口")
|
||||
@RequestMapping("/system/log")
|
||||
|
||||
Reference in New Issue
Block a user