modified 增加结构体描述，完善自动化文档

server/model/request/common.go

@@ -2,13 +2,13 @@ package request
 
 // Paging common input parameter structure
 type PageInfo struct {
-	Page     int `json:"page" form:"page"`
-	PageSize int `json:"pageSize" form:"pageSize"`
+	Page     int `json:"page" form:"page"`         // 页码
+	PageSize int `json:"pageSize" form:"pageSize"` // 每页大小
 }
 
 // Find by id structure
 type GetById struct {
-	Id float64 `json:"id" form:"id"`
+	Id float64 `json:"id" form:"id"` // 主键ID
 }
 
 type IdsReq struct {
@@ -17,7 +17,7 @@ type IdsReq struct {
 
 // Get role by id structure
 type GetAuthorityId struct {
-	AuthorityId string
+	AuthorityId string // 角色ID
 }
 
 type Empty struct{}

server/model/request/sys_api.go

@@ -6,6 +6,6 @@ import "gin-vue-admin/model"
 type SearchApiParams struct {
 	model.SysApi
 	PageInfo
-	OrderKey string `json:"orderKey"`
-	Desc     bool   `json:"desc"`
+	OrderKey string `json:"orderKey"` // 排序
+	Desc     bool   `json:"desc"`     // 排序方式:升序false(默认)|降序true
 }

server/model/request/sys_casbin.go

@@ -2,12 +2,12 @@ package request
 
 // Casbin info structure
 type CasbinInfo struct {
-	Path   string `json:"path"`
-	Method string `json:"method"`
+	Path   string `json:"path"`   // 路径
+	Method string `json:"method"` // 方法
 }
 
 // Casbin structure for input parameters
 type CasbinInReceive struct {
-	AuthorityId string       `json:"authorityId"`
+	AuthorityId string       `json:"authorityId"` // 权限id
 	CasbinInfos []CasbinInfo `json:"casbinInfos"`
 }

server/model/request/sys_init.go

@@ -1,9 +1,9 @@
 package request
 
 type InitDB struct {
-	Host     string `json:"host"`
-	Port     string `json:"port"`
-	UserName string `json:"userName" binding:"required"`
-	Password string `json:"password"`
-	DBName   string `json:"dbName" binding:"required"`
+	Host     string `json:"host"`                        // 服务器地址
+	Port     string `json:"port"`                        // 数据库连接端口
+	UserName string `json:"userName" binding:"required"` // 数据库用户名
+	Password string `json:"password"`                    // 数据库密码
+	DBName   string `json:"dbName" binding:"required"`   // 数据库名
 }

server/model/request/sys_menu.go

@@ -5,5 +5,5 @@ import "gin-vue-admin/model"
 // Add menu authority info structure
 type AddMenuAuthorityInfo struct {
 	Menus       []model.SysBaseMenu
-	AuthorityId string
+	AuthorityId string // 角色ID
 }

server/model/request/sys_user.go

@@ -13,21 +13,21 @@ type Register struct {
 
 // User login structure
 type Login struct {
-	Username  string `json:"username"`
-	Password  string `json:"password"`
-	Captcha   string `json:"captcha"`
-	CaptchaId string `json:"captchaId"`
+	Username  string `json:"username"`  // 用户名
+	Password  string `json:"password"`  // 密码
+	Captcha   string `json:"captcha"`   // 验证码
+	CaptchaId string `json:"captchaId"` // 验证码ID
 }
 
 // Modify password structure
 type ChangePasswordStruct struct {
-	Username    string `json:"username"`
-	Password    string `json:"password"`
-	NewPassword string `json:"newPassword"`
+	Username    string `json:"username"`    // 用户名
+	Password    string `json:"password"`    // 密码
+	NewPassword string `json:"newPassword"` // 新密码
 }
 
 // Modify  user's auth structure
 type SetUserAuth struct {
-	UUID        uuid.UUID `json:"uuid"`
-	AuthorityId string    `json:"authorityId"`
+	UUID        uuid.UUID `json:"uuid"`        // 用户UUID
+	AuthorityId string    `json:"authorityId"` // 角色ID
 }