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

2021-04-30 14:14:00 +08:00
parent f9296d90d4
commit 3e85645e44
31 changed files with 881 additions and 388 deletions
@@ -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
 }