diff --git a/src/main/kotlin/top/fatweb/api/FatWebApiApplication.kt b/src/main/kotlin/top/fatweb/api/FatWebApiApplication.kt
index 485fead..0d5f029 100644
--- a/src/main/kotlin/top/fatweb/api/FatWebApiApplication.kt
+++ b/src/main/kotlin/top/fatweb/api/FatWebApiApplication.kt
@@ -7,6 +7,12 @@ import org.springframework.transaction.annotation.EnableTransactionManagement
import java.io.File
import java.util.*
+/**
+ * Application main class
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@SpringBootApplication
@EnableTransactionManagement
class FatWebApiApplication
diff --git a/src/main/kotlin/top/fatweb/api/annotation/ApiVersion.kt b/src/main/kotlin/top/fatweb/api/annotation/ApiVersion.kt
index a0b064c..84f702f 100644
--- a/src/main/kotlin/top/fatweb/api/annotation/ApiVersion.kt
+++ b/src/main/kotlin/top/fatweb/api/annotation/ApiVersion.kt
@@ -2,6 +2,12 @@ package top.fatweb.api.annotation
import org.springframework.core.annotation.AliasFor
+/**
+ * Api controller version annotation
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
annotation class ApiVersion(
diff --git a/src/main/kotlin/top/fatweb/api/config/DataFormatConfig.kt b/src/main/kotlin/top/fatweb/api/config/DataFormatConfig.kt
index 3a7b76c..e50dc07 100644
--- a/src/main/kotlin/top/fatweb/api/config/DataFormatConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/DataFormatConfig.kt
@@ -13,7 +13,12 @@ import java.time.LocalDateTime
import java.time.format.DateTimeFormatter
import java.util.*
-
+/**
+ * Data format config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@JsonComponent
class DataFormatConfig {
@set:Value("\${spring.jackson.date-format}")
diff --git a/src/main/kotlin/top/fatweb/api/config/FilterConfig.kt b/src/main/kotlin/top/fatweb/api/config/FilterConfig.kt
index 71374f9..e9f8c3d 100644
--- a/src/main/kotlin/top/fatweb/api/config/FilterConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/FilterConfig.kt
@@ -5,6 +5,12 @@ import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import top.fatweb.api.filter.ExceptionFilter
+/**
+ * Filter config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Configuration
class FilterConfig {
@Bean
diff --git a/src/main/kotlin/top/fatweb/api/config/InitConfig.kt b/src/main/kotlin/top/fatweb/api/config/InitConfig.kt
index 9eab4ca..a055dea 100644
--- a/src/main/kotlin/top/fatweb/api/config/InitConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/InitConfig.kt
@@ -14,6 +14,12 @@ import top.fatweb.api.service.permission.IUserInfoService
import top.fatweb.api.service.permission.IUserService
import kotlin.random.Random
+/**
+ * Application initialization config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@DependsOn("adminProperties")
@Component
class InitConfig(
diff --git a/src/main/kotlin/top/fatweb/api/config/MybatisPlusConfig.kt b/src/main/kotlin/top/fatweb/api/config/MybatisPlusConfig.kt
index 2ce739c..f4371ae 100644
--- a/src/main/kotlin/top/fatweb/api/config/MybatisPlusConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/MybatisPlusConfig.kt
@@ -6,6 +6,12 @@ import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerIntercept
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
+/**
+ * Mybatis-plus config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Configuration
class MybatisPlusConfig {
@Bean
diff --git a/src/main/kotlin/top/fatweb/api/config/RedisConfig.kt b/src/main/kotlin/top/fatweb/api/config/RedisConfig.kt
index 14d3ee0..1eee6bb 100644
--- a/src/main/kotlin/top/fatweb/api/config/RedisConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/RedisConfig.kt
@@ -12,6 +12,12 @@ import org.springframework.data.redis.core.RedisTemplate
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer
import org.springframework.data.redis.serializer.StringRedisSerializer
+/**
+ * Redis config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Configuration
class RedisConfig {
@Bean
diff --git a/src/main/kotlin/top/fatweb/api/config/SecurityConfig.kt b/src/main/kotlin/top/fatweb/api/config/SecurityConfig.kt
index 3c9602d..f57d6cd 100644
--- a/src/main/kotlin/top/fatweb/api/config/SecurityConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/SecurityConfig.kt
@@ -17,6 +17,12 @@ import top.fatweb.api.filter.JwtAuthenticationTokenFilter
import top.fatweb.api.handler.JwtAccessDeniedHandler
import top.fatweb.api.handler.JwtAuthenticationEntryPointHandler
+/**
+ * Spring Security config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Configuration
@EnableMethodSecurity
class SecurityConfig(
diff --git a/src/main/kotlin/top/fatweb/api/config/SwaggerConfig.kt b/src/main/kotlin/top/fatweb/api/config/SwaggerConfig.kt
index 0525655..800cb9d 100644
--- a/src/main/kotlin/top/fatweb/api/config/SwaggerConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/SwaggerConfig.kt
@@ -7,6 +7,12 @@ import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import top.fatweb.api.properties.ServerProperties
+/**
+ * Swagger API doc config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Configuration
class SwaggerConfig {
diff --git a/src/main/kotlin/top/fatweb/api/config/SysLogConfig.kt b/src/main/kotlin/top/fatweb/api/config/SysLogConfig.kt
index ba1c40b..942e42e 100644
--- a/src/main/kotlin/top/fatweb/api/config/SysLogConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/SysLogConfig.kt
@@ -5,6 +5,12 @@ import org.springframework.web.servlet.config.annotation.InterceptorRegistry
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
import top.fatweb.api.interceptor.SysLogInterceptor
+/**
+ * System log config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Configuration
class SysLogConfig(
private val sysLogInterceptor: SysLogInterceptor
diff --git a/src/main/kotlin/top/fatweb/api/config/WebMvcRegistrationsConfig.kt b/src/main/kotlin/top/fatweb/api/config/WebMvcRegistrationsConfig.kt
index 1db6a0f..1a9110f 100644
--- a/src/main/kotlin/top/fatweb/api/config/WebMvcRegistrationsConfig.kt
+++ b/src/main/kotlin/top/fatweb/api/config/WebMvcRegistrationsConfig.kt
@@ -5,6 +5,12 @@ import org.springframework.context.annotation.Configuration
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping
import top.fatweb.api.util.ApiResponseMappingHandlerMapping
+/**
+ * Web MVC config
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Configuration
class WebMvcRegistrationsConfig : WebMvcRegistrations {
override fun getRequestMappingHandlerMapping(): RequestMappingHandlerMapping = ApiResponseMappingHandlerMapping()
diff --git a/src/main/kotlin/top/fatweb/api/controller/ExceptionController.kt b/src/main/kotlin/top/fatweb/api/controller/ExceptionController.kt
index e5dfad2..f0c81b1 100644
--- a/src/main/kotlin/top/fatweb/api/controller/ExceptionController.kt
+++ b/src/main/kotlin/top/fatweb/api/controller/ExceptionController.kt
@@ -5,6 +5,12 @@ import jakarta.servlet.http.HttpServletRequest
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
+/**
+ * Exception controller
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Hidden
@RestController
@RequestMapping("/error")
diff --git a/src/main/kotlin/top/fatweb/api/controller/permission/AuthenticationController.kt b/src/main/kotlin/top/fatweb/api/controller/permission/AuthenticationController.kt
index 3c0ded1..2e4d3d2 100644
--- a/src/main/kotlin/top/fatweb/api/controller/permission/AuthenticationController.kt
+++ b/src/main/kotlin/top/fatweb/api/controller/permission/AuthenticationController.kt
@@ -15,6 +15,12 @@ import top.fatweb.api.param.authentication.LoginParam
import top.fatweb.api.service.permission.IAuthenticationService
import top.fatweb.api.util.WebUtil
+/**
+ * Authentication controller
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Tag(name = "身份认证", description = "身份认证相关接口")
@RestController
class AuthenticationController(
diff --git a/src/main/kotlin/top/fatweb/api/controller/permission/GroupController.kt b/src/main/kotlin/top/fatweb/api/controller/permission/GroupController.kt
index 02912da..54947d4 100644
--- a/src/main/kotlin/top/fatweb/api/controller/permission/GroupController.kt
+++ b/src/main/kotlin/top/fatweb/api/controller/permission/GroupController.kt
@@ -13,12 +13,10 @@ import top.fatweb.api.vo.permission.GroupVo
import top.fatweb.api.vo.permission.GroupWithRoleVo
/**
- *
- * 用户组表 前端控制器
- *
+ * Group controller
*
* @author FatttSnake
- * @since 2023-11-09
+ * @since 1.0.0
*/
@Tag(name = "用户组管理", description = "用户组管理相关接口")
@RestController
diff --git a/src/main/kotlin/top/fatweb/api/controller/permission/PowerController.kt b/src/main/kotlin/top/fatweb/api/controller/permission/PowerController.kt
index d031d75..ceec0cd 100644
--- a/src/main/kotlin/top/fatweb/api/controller/permission/PowerController.kt
+++ b/src/main/kotlin/top/fatweb/api/controller/permission/PowerController.kt
@@ -9,7 +9,10 @@ import top.fatweb.api.entity.common.ResponseResult
import top.fatweb.api.service.permission.IPowerService
/**
- * 权限 前端控制器
+ * Power controller
+ *
+ * @author FatttSnake
+ * @since 1.0.0
*/
@Tag(name = "权限管理", description = "权限管理相关接口")
@RestController
diff --git a/src/main/kotlin/top/fatweb/api/controller/permission/RoleController.kt b/src/main/kotlin/top/fatweb/api/controller/permission/RoleController.kt
index e0400e3..5422ca8 100644
--- a/src/main/kotlin/top/fatweb/api/controller/permission/RoleController.kt
+++ b/src/main/kotlin/top/fatweb/api/controller/permission/RoleController.kt
@@ -13,10 +13,10 @@ import top.fatweb.api.vo.permission.RoleVo
import top.fatweb.api.vo.permission.RoleWithPowerVo
/**
- * 角色表 前端控制器
+ * Role controller
*
* @author FatttSnake
- * @since 2023-11-09
+ * @since 1.0.0
*/
@Tag(name = "角色管理", description = "角色管理相关接口")
@RestController
diff --git a/src/main/kotlin/top/fatweb/api/controller/permission/UserController.kt b/src/main/kotlin/top/fatweb/api/controller/permission/UserController.kt
index 2dc0f2f..750195b 100644
--- a/src/main/kotlin/top/fatweb/api/controller/permission/UserController.kt
+++ b/src/main/kotlin/top/fatweb/api/controller/permission/UserController.kt
@@ -12,12 +12,10 @@ import top.fatweb.api.vo.permission.UserWithPowerInfoVo
import top.fatweb.api.vo.permission.UserWithRoleInfoVo
/**
- *
- * 用户表 前端控制器
- *
+ * User controller
*
* @author FatttSnake
- * @since 2023-10-04
+ * @since 1.0.0
*/
@Tag(name = "用户管理", description = "用户管理相关接口")
@RestController
diff --git a/src/main/kotlin/top/fatweb/api/controller/system/SysLogController.kt b/src/main/kotlin/top/fatweb/api/controller/system/SysLogController.kt
index 6e1cf42..6769f48 100644
--- a/src/main/kotlin/top/fatweb/api/controller/system/SysLogController.kt
+++ b/src/main/kotlin/top/fatweb/api/controller/system/SysLogController.kt
@@ -12,15 +12,13 @@ import top.fatweb.api.entity.common.ResponseResult
import top.fatweb.api.param.system.SysLogGetParam
import top.fatweb.api.service.system.ISysLogService
import top.fatweb.api.vo.PageVo
-import top.fatweb.api.vo.system.SysLogGetVo
+import top.fatweb.api.vo.system.SysLogVo
/**
- *
- * 系统日志表 前端控制器
- *
+ * System log controller
*
* @author FatttSnake
- * @since 2023-10-18
+ * @since 1.0.0
*/
@RestController
@RequestMapping("/system/log")
@@ -30,7 +28,7 @@ class SysLogController(
) {
@Operation(summary = "获取")
@GetMapping
- fun get(@Valid sysLogGetParam: SysLogGetParam?): ResponseResult> {
+ fun get(@Valid sysLogGetParam: SysLogGetParam?): ResponseResult> {
return ResponseResult.success(
ResponseCode.DATABASE_SELECT_SUCCESS, data = SysLogConverter.sysLogPageToSysLogPageVo(
sysLogService.getPage(sysLogGetParam)
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/ElementConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/ElementConverter.kt
index 3ab25e1..33037ec 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/ElementConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/ElementConverter.kt
@@ -3,6 +3,12 @@ package top.fatweb.api.converter.permission
import top.fatweb.api.entity.permission.Element
import top.fatweb.api.vo.permission.ElementVo
+/**
+ * Element converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object ElementConverter {
fun elementToElementVo(element: Element) = ElementVo(
id = element.id,
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/GroupConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/GroupConverter.kt
index bc66d32..2aa7be3 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/GroupConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/GroupConverter.kt
@@ -10,6 +10,12 @@ import top.fatweb.api.vo.PageVo
import top.fatweb.api.vo.permission.GroupVo
import top.fatweb.api.vo.permission.GroupWithRoleVo
+/**
+ * Group converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object GroupConverter {
fun groupToGroupVo(group: Group) = GroupVo(
id = group.id,
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/MenuConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/MenuConverter.kt
index 3f03508..f1ae116 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/MenuConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/MenuConverter.kt
@@ -3,6 +3,12 @@ package top.fatweb.api.converter.permission
import top.fatweb.api.entity.permission.Menu
import top.fatweb.api.vo.permission.MenuVo
+/**
+ * Menu converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object MenuConverter {
fun menuToMenuVo(menu: Menu) = MenuVo(
id = menu.id,
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/ModuleConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/ModuleConverter.kt
index c7bd76b..e885203 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/ModuleConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/ModuleConverter.kt
@@ -3,6 +3,12 @@ package top.fatweb.api.converter.permission
import top.fatweb.api.entity.permission.Module
import top.fatweb.api.vo.permission.ModuleVo
+/**
+ * Module converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object ModuleConverter {
fun moduleToModuleVo(module: Module) = ModuleVo(
id = module.id,
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/OperationConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/OperationConverter.kt
index 0c3cd5d..ebf17a2 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/OperationConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/OperationConverter.kt
@@ -3,6 +3,12 @@ package top.fatweb.api.converter.permission
import top.fatweb.api.entity.permission.Operation
import top.fatweb.api.vo.permission.OperationVo
+/**
+ * Operation converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object OperationConverter {
fun operationToOperationVo(operation: Operation) = OperationVo(
id = operation.id,
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/PowerConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/PowerConverter.kt
index 43877fb..30dfcc3 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/PowerConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/PowerConverter.kt
@@ -3,6 +3,12 @@ package top.fatweb.api.converter.permission
import top.fatweb.api.entity.permission.PowerSet
import top.fatweb.api.vo.permission.PowerSetVo
+/**
+ * Power converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object PowerConverter {
fun powerSetToPowerSetVo(powerSet: PowerSet) = PowerSetVo(
moduleList = powerSet.moduleList?.map { ModuleConverter.moduleToModuleVo(it) },
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/RoleConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/RoleConverter.kt
index a6bc7c1..5d04df6 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/RoleConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/RoleConverter.kt
@@ -10,6 +10,12 @@ import top.fatweb.api.vo.PageVo
import top.fatweb.api.vo.permission.RoleVo
import top.fatweb.api.vo.permission.RoleWithPowerVo
+/**
+ * Role converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object RoleConverter {
fun roleToRoleVo(role: Role) = RoleVo(
id = role.id,
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/UserConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/UserConverter.kt
index e84b210..cbc995c 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/UserConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/UserConverter.kt
@@ -4,6 +4,12 @@ import top.fatweb.api.entity.permission.User
import top.fatweb.api.param.authentication.LoginParam
import top.fatweb.api.vo.permission.*
+/**
+ * User converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object UserConverter {
fun loginParamToUser(loginParam: LoginParam) = User().apply {
username = loginParam.username
diff --git a/src/main/kotlin/top/fatweb/api/converter/permission/UserInfoConverter.kt b/src/main/kotlin/top/fatweb/api/converter/permission/UserInfoConverter.kt
index 0d3e2b6..59c0252 100644
--- a/src/main/kotlin/top/fatweb/api/converter/permission/UserInfoConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/permission/UserInfoConverter.kt
@@ -3,6 +3,12 @@ package top.fatweb.api.converter.permission
import top.fatweb.api.entity.permission.UserInfo
import top.fatweb.api.vo.permission.UserInfoVo
+/**
+ * User information converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object UserInfoConverter {
fun userInfoToUserInfoVo(userInfo: UserInfo) = UserInfoVo(
id = userInfo.id,
diff --git a/src/main/kotlin/top/fatweb/api/converter/system/SysLogConverter.kt b/src/main/kotlin/top/fatweb/api/converter/system/SysLogConverter.kt
index 7ba551c..7b3b906 100644
--- a/src/main/kotlin/top/fatweb/api/converter/system/SysLogConverter.kt
+++ b/src/main/kotlin/top/fatweb/api/converter/system/SysLogConverter.kt
@@ -3,16 +3,22 @@ package top.fatweb.api.converter.system
import com.baomidou.mybatisplus.core.metadata.IPage
import top.fatweb.api.entity.system.SysLog
import top.fatweb.api.vo.PageVo
-import top.fatweb.api.vo.system.SysLogGetVo
+import top.fatweb.api.vo.system.SysLogVo
+/**
+ * System log converter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
object SysLogConverter {
- fun sysLogPageToSysLogPageVo(syslogPage: IPage): PageVo = PageVo(
+ fun sysLogPageToSysLogPageVo(syslogPage: IPage): PageVo = PageVo(
syslogPage.total,
syslogPage.pages,
syslogPage.size,
syslogPage.current,
syslogPage.records.map {
- SysLogGetVo(
+ SysLogVo(
id = it.id,
logType = it.logType,
operateUserId = it.operateUserId,
diff --git a/src/main/kotlin/top/fatweb/api/entity/common/BusinessCode.kt b/src/main/kotlin/top/fatweb/api/entity/common/BusinessCode.kt
index 02178f5..e4bc399 100644
--- a/src/main/kotlin/top/fatweb/api/entity/common/BusinessCode.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/common/BusinessCode.kt
@@ -1,5 +1,11 @@
package top.fatweb.api.entity.common
+/**
+ * Business code entity
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
enum class BusinessCode(val code: Int) {
SYSTEM(100),
DATABASE(200)
diff --git a/src/main/kotlin/top/fatweb/api/entity/common/ResponseCode.kt b/src/main/kotlin/top/fatweb/api/entity/common/ResponseCode.kt
index 18d621e..4de6865 100644
--- a/src/main/kotlin/top/fatweb/api/entity/common/ResponseCode.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/common/ResponseCode.kt
@@ -1,5 +1,11 @@
package top.fatweb.api.entity.common
+/**
+ * Response code entity
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
enum class ResponseCode(val code: Int) {
SYSTEM_OK(BusinessCode.SYSTEM, 0),
SYSTEM_LOGIN_SUCCESS(BusinessCode.SYSTEM, 20),
diff --git a/src/main/kotlin/top/fatweb/api/entity/common/ResponseResult.kt b/src/main/kotlin/top/fatweb/api/entity/common/ResponseResult.kt
index fb5452e..601acc1 100644
--- a/src/main/kotlin/top/fatweb/api/entity/common/ResponseResult.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/common/ResponseResult.kt
@@ -3,6 +3,12 @@ package top.fatweb.api.entity.common
import io.swagger.v3.oas.annotations.media.Schema
import java.io.Serializable
+/**
+ * Response result entity
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
class ResponseResult private constructor(
@Schema(description = "响应码", defaultValue = "200") val code: Int,
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/Element.kt b/src/main/kotlin/top/fatweb/api/entity/permission/Element.kt
index 533b762..106bb07 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/Element.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/Element.kt
@@ -6,12 +6,10 @@ import com.baomidou.mybatisplus.annotation.TableName
import java.io.Serializable
/**
- *
- * 页面元素表
- *
+ * Element entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_element")
class Element : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/Group.kt b/src/main/kotlin/top/fatweb/api/entity/permission/Group.kt
index 732feb8..5d0109e 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/Group.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/Group.kt
@@ -5,12 +5,10 @@ import java.io.Serializable
import java.time.LocalDateTime
/**
- *
- * 用户组表
- *
+ * Group entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_group")
class Group : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/LoginUser.kt b/src/main/kotlin/top/fatweb/api/entity/permission/LoginUser.kt
index 84837d7..a31223d 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/LoginUser.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/LoginUser.kt
@@ -7,6 +7,12 @@ import org.springframework.security.core.userdetails.UserDetails
import java.time.LocalDateTime
import java.time.ZoneOffset
+/**
+ * Login user entity
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
class LoginUser() : UserDetails {
lateinit var user: User
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/Menu.kt b/src/main/kotlin/top/fatweb/api/entity/permission/Menu.kt
index 79964d4..2ef1935 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/Menu.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/Menu.kt
@@ -6,12 +6,10 @@ import com.baomidou.mybatisplus.annotation.TableName
import java.io.Serializable
/**
- *
- * 菜单表
- *
+ * Menu entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_menu")
class Menu : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/Module.kt b/src/main/kotlin/top/fatweb/api/entity/permission/Module.kt
index 088cd86..2d76a4b 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/Module.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/Module.kt
@@ -6,12 +6,10 @@ import com.baomidou.mybatisplus.annotation.TableName
import java.io.Serializable
/**
- *
- * 模块表
- *
+ * Module Entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_module")
class Module : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/Operation.kt b/src/main/kotlin/top/fatweb/api/entity/permission/Operation.kt
index 9970982..2cbe6ab 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/Operation.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/Operation.kt
@@ -6,12 +6,10 @@ import com.baomidou.mybatisplus.annotation.TableName
import java.io.Serializable
/**
- *
- * 功能表
- *
+ * Operation entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_operation")
class Operation : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/Power.kt b/src/main/kotlin/top/fatweb/api/entity/permission/Power.kt
index 7886707..2446b6d 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/Power.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/Power.kt
@@ -6,12 +6,10 @@ import com.baomidou.mybatisplus.annotation.TableName
import java.io.Serializable
/**
- *
- * 权限表
- *
+ * Power entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_power")
class Power : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/PowerRole.kt b/src/main/kotlin/top/fatweb/api/entity/permission/PowerRole.kt
index 43c87af..58730c1 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/PowerRole.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/PowerRole.kt
@@ -4,12 +4,10 @@ import com.baomidou.mybatisplus.annotation.*
import java.io.Serializable
/**
- *
- * 中间表-权限-角色
- *
+ * Power role intermediate entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_power_role")
class PowerRole : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/PowerSet.kt b/src/main/kotlin/top/fatweb/api/entity/permission/PowerSet.kt
index 744862d..3268be0 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/PowerSet.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/PowerSet.kt
@@ -3,7 +3,10 @@ package top.fatweb.api.entity.permission
import java.io.Serializable
/**
- * 权限集合
+ * Set of power entity
+ *
+ * @author FatttSnake
+ * @since 1.0.0
*/
class PowerSet : Serializable {
var moduleList: List? = null
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/PowerType.kt b/src/main/kotlin/top/fatweb/api/entity/permission/PowerType.kt
index af0056e..6119271 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/PowerType.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/PowerType.kt
@@ -6,12 +6,10 @@ import com.baomidou.mybatisplus.annotation.TableName
import java.io.Serializable
/**
- *
- * 权限类型表
- *
+ * Power type entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_power_type")
class PowerType : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/Role.kt b/src/main/kotlin/top/fatweb/api/entity/permission/Role.kt
index 6f31557..730a0b1 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/Role.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/Role.kt
@@ -5,12 +5,10 @@ import java.io.Serializable
import java.time.LocalDateTime
/**
- *
- * 角色表
- *
+ * Role entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_role")
class Role : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/RoleGroup.kt b/src/main/kotlin/top/fatweb/api/entity/permission/RoleGroup.kt
index 2d780b5..a56eff2 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/RoleGroup.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/RoleGroup.kt
@@ -4,12 +4,10 @@ import com.baomidou.mybatisplus.annotation.*
import java.io.Serializable
/**
- *
- * 中间表-角色-用户组
- *
+ * Role group intermediate entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_role_group")
class RoleGroup : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/User.kt b/src/main/kotlin/top/fatweb/api/entity/permission/User.kt
index 7286e41..da9dd97 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/User.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/User.kt
@@ -5,12 +5,10 @@ import java.io.Serializable
import java.time.LocalDateTime
/**
- *
- * 用户表
- *
+ * User entity
*
* @author FatttSnake
- * @since 2023-10-04
+ * @since 1.0.0
*/
@TableName("t_user")
class User() : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/UserGroup.kt b/src/main/kotlin/top/fatweb/api/entity/permission/UserGroup.kt
index ad2264f..8438feb 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/UserGroup.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/UserGroup.kt
@@ -4,12 +4,10 @@ import com.baomidou.mybatisplus.annotation.*
import java.io.Serializable
/**
- *
- * 中间表-用户-用户组
- *
+ * User group intermediate entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_user_group")
class UserGroup : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/UserInfo.kt b/src/main/kotlin/top/fatweb/api/entity/permission/UserInfo.kt
index dfe59f4..71a8294 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/UserInfo.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/UserInfo.kt
@@ -5,12 +5,10 @@ import java.io.Serializable
import java.time.LocalDateTime
/**
- *
- * 用户资料表
- *
+ * User information entity
*
* @author FatttSnake
- * @since 2023-10-30
+ * @since 1.0.0
*/
@TableName("t_user_info")
class UserInfo : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/permission/UserRole.kt b/src/main/kotlin/top/fatweb/api/entity/permission/UserRole.kt
index ffd6c49..d96e836 100644
--- a/src/main/kotlin/top/fatweb/api/entity/permission/UserRole.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/permission/UserRole.kt
@@ -4,12 +4,10 @@ import com.baomidou.mybatisplus.annotation.*
import java.io.Serializable
/**
- *
- * 中间表-用户-角色
- *
+ * User role intermediate entity
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@TableName("t_user_role")
class UserRole : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/entity/system/SysLog.kt b/src/main/kotlin/top/fatweb/api/entity/system/SysLog.kt
index 304228c..5f0bd65 100644
--- a/src/main/kotlin/top/fatweb/api/entity/system/SysLog.kt
+++ b/src/main/kotlin/top/fatweb/api/entity/system/SysLog.kt
@@ -7,12 +7,10 @@ import java.io.Serializable
import java.time.LocalDateTime
/**
- *
- * 系统日志表
- *
+ * System log entity
*
* @author FatttSnake
- * @since 2023-10-18
+ * @since 1.0.0
*/
@TableName("t_sys_log")
class SysLog : Serializable {
diff --git a/src/main/kotlin/top/fatweb/api/exception/TokenHasExpiredException.kt b/src/main/kotlin/top/fatweb/api/exception/TokenHasExpiredException.kt
index 2b0521f..fbd8a05 100644
--- a/src/main/kotlin/top/fatweb/api/exception/TokenHasExpiredException.kt
+++ b/src/main/kotlin/top/fatweb/api/exception/TokenHasExpiredException.kt
@@ -1,3 +1,9 @@
package top.fatweb.api.exception
+/**
+ * Token has expired exception
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
class TokenHasExpiredException : RuntimeException("Token has expired")
\ No newline at end of file
diff --git a/src/main/kotlin/top/fatweb/api/filter/ExceptionFilter.kt b/src/main/kotlin/top/fatweb/api/filter/ExceptionFilter.kt
index 0d4ac53..6398fcd 100644
--- a/src/main/kotlin/top/fatweb/api/filter/ExceptionFilter.kt
+++ b/src/main/kotlin/top/fatweb/api/filter/ExceptionFilter.kt
@@ -6,6 +6,12 @@ import jakarta.servlet.ServletRequest
import jakarta.servlet.ServletResponse
import org.springframework.stereotype.Component
+/**
+ * Exception filter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Component
class ExceptionFilter : Filter {
override fun doFilter(
diff --git a/src/main/kotlin/top/fatweb/api/filter/JwtAuthenticationTokenFilter.kt b/src/main/kotlin/top/fatweb/api/filter/JwtAuthenticationTokenFilter.kt
index 3078509..4173d58 100644
--- a/src/main/kotlin/top/fatweb/api/filter/JwtAuthenticationTokenFilter.kt
+++ b/src/main/kotlin/top/fatweb/api/filter/JwtAuthenticationTokenFilter.kt
@@ -15,6 +15,12 @@ import top.fatweb.api.util.JwtUtil
import top.fatweb.api.util.RedisUtil
import top.fatweb.api.util.WebUtil
+/**
+ * Jwt authentication token filter
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Component
class JwtAuthenticationTokenFilter(private val redisUtil: RedisUtil) : OncePerRequestFilter() {
override fun doFilterInternal(
diff --git a/src/main/kotlin/top/fatweb/api/handler/DataMetaObjectHandler.kt b/src/main/kotlin/top/fatweb/api/handler/DataMetaObjectHandler.kt
index b4b87a8..359ee9a 100644
--- a/src/main/kotlin/top/fatweb/api/handler/DataMetaObjectHandler.kt
+++ b/src/main/kotlin/top/fatweb/api/handler/DataMetaObjectHandler.kt
@@ -6,6 +6,12 @@ import org.springframework.stereotype.Component
import java.time.LocalDateTime
import java.time.ZoneOffset
+/**
+ * Date meta object handler
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Component
class DataMetaObjectHandler : MetaObjectHandler {
override fun insertFill(metaObject: MetaObject?) {
diff --git a/src/main/kotlin/top/fatweb/api/handler/ExceptionHandler.kt b/src/main/kotlin/top/fatweb/api/handler/ExceptionHandler.kt
index e8d9150..a1d3100 100644
--- a/src/main/kotlin/top/fatweb/api/handler/ExceptionHandler.kt
+++ b/src/main/kotlin/top/fatweb/api/handler/ExceptionHandler.kt
@@ -19,6 +19,12 @@ import top.fatweb.api.entity.common.ResponseCode
import top.fatweb.api.entity.common.ResponseResult
import top.fatweb.api.exception.TokenHasExpiredException
+/**
+ * Exception handler
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@RestControllerAdvice
class ExceptionHandler {
private val logger: Logger = LoggerFactory.getLogger(this::class.java)
diff --git a/src/main/kotlin/top/fatweb/api/handler/JwtAccessDeniedHandler.kt b/src/main/kotlin/top/fatweb/api/handler/JwtAccessDeniedHandler.kt
index a47a8c9..feddac2 100644
--- a/src/main/kotlin/top/fatweb/api/handler/JwtAccessDeniedHandler.kt
+++ b/src/main/kotlin/top/fatweb/api/handler/JwtAccessDeniedHandler.kt
@@ -6,6 +6,12 @@ import org.springframework.security.access.AccessDeniedException
import org.springframework.security.web.access.AccessDeniedHandler
import org.springframework.stereotype.Component
+/**
+ * Jwt access denied handler
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Component
class JwtAccessDeniedHandler : AccessDeniedHandler {
override fun handle(
diff --git a/src/main/kotlin/top/fatweb/api/handler/JwtAuthenticationEntryPointHandler.kt b/src/main/kotlin/top/fatweb/api/handler/JwtAuthenticationEntryPointHandler.kt
index 4725a66..a2af324 100644
--- a/src/main/kotlin/top/fatweb/api/handler/JwtAuthenticationEntryPointHandler.kt
+++ b/src/main/kotlin/top/fatweb/api/handler/JwtAuthenticationEntryPointHandler.kt
@@ -6,6 +6,12 @@ import org.springframework.security.core.AuthenticationException
import org.springframework.security.web.AuthenticationEntryPoint
import org.springframework.stereotype.Component
+/**
+ * Jwt authentication entry point handler
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@Component
class JwtAuthenticationEntryPointHandler : AuthenticationEntryPoint {
override fun commence(
diff --git a/src/main/kotlin/top/fatweb/api/interceptor/SysLogInterceptor.kt b/src/main/kotlin/top/fatweb/api/interceptor/SysLogInterceptor.kt
index b9a1452..48dd9d5 100644
--- a/src/main/kotlin/top/fatweb/api/interceptor/SysLogInterceptor.kt
+++ b/src/main/kotlin/top/fatweb/api/interceptor/SysLogInterceptor.kt
@@ -22,6 +22,12 @@ import java.time.temporal.ChronoUnit
import java.util.*
import java.util.concurrent.Executor
+/**
+ * System log interceptor
+ *
+ * @author FatttSnake
+ * @since 1.0.0
+ */
@ControllerAdvice
class SysLogInterceptor(
private val customThreadPoolTaskExecutor: Executor, private val sysLogService: ISysLogService
diff --git a/src/main/kotlin/top/fatweb/api/mapper/permission/ElementMapper.kt b/src/main/kotlin/top/fatweb/api/mapper/permission/ElementMapper.kt
index b3de56c..f350e7f 100644
--- a/src/main/kotlin/top/fatweb/api/mapper/permission/ElementMapper.kt
+++ b/src/main/kotlin/top/fatweb/api/mapper/permission/ElementMapper.kt
@@ -5,12 +5,10 @@ import org.apache.ibatis.annotations.Mapper
import top.fatweb.api.entity.permission.Element
/**
- *
- * 页面元素表 Mapper 接口
- *
+ * Element mapper
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@Mapper
interface ElementMapper : BaseMapper
diff --git a/src/main/kotlin/top/fatweb/api/mapper/permission/GroupMapper.kt b/src/main/kotlin/top/fatweb/api/mapper/permission/GroupMapper.kt
index a9b500e..585ce47 100644
--- a/src/main/kotlin/top/fatweb/api/mapper/permission/GroupMapper.kt
+++ b/src/main/kotlin/top/fatweb/api/mapper/permission/GroupMapper.kt
@@ -6,12 +6,10 @@ import org.apache.ibatis.annotations.Mapper
import top.fatweb.api.entity.permission.Group
/**
- *
- * 用户组表 Mapper 接口
- *
+ * Group mapper
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@Mapper
interface GroupMapper : BaseMapper {
diff --git a/src/main/kotlin/top/fatweb/api/mapper/permission/MenuMapper.kt b/src/main/kotlin/top/fatweb/api/mapper/permission/MenuMapper.kt
index f50941a..4001264 100644
--- a/src/main/kotlin/top/fatweb/api/mapper/permission/MenuMapper.kt
+++ b/src/main/kotlin/top/fatweb/api/mapper/permission/MenuMapper.kt
@@ -5,12 +5,10 @@ import org.apache.ibatis.annotations.Mapper
import top.fatweb.api.entity.permission.Menu
/**
- *
- * 菜单表 Mapper 接口
- *
+ * Menu mapper
*
* @author FatttSnake
- * @since 2023-10-25
+ * @since 1.0.0
*/
@Mapper
interface MenuMapper : BaseMapper