Skip to content

Commit

Permalink
fix: require properties in api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
suyuan32 committed Sep 13, 2022
1 parent 30fc5ea commit 5e283cb
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 21 deletions.
13 changes: 13 additions & 0 deletions api/api_desc/menu.api
Original file line number Diff line number Diff line change
Expand Up @@ -103,22 +103,30 @@ type (
// swagger:model CreateOrUpdateMenuReq
CreateOrUpdateMenuReq {
// ID
// Required: true
ID uint32 `json:"id"`
// Menu type: directory or menu | 菜单类型: 目录或菜单
menuType uint32 `json:"type"`
// Parent menu ID | 父级菜单ID
// Required: true
ParentId uint `json:"parentId"`
// The path to visit menu | 菜单访问路径
// Required: true
Path string `json:"path"`
// Menu name | 菜单名
// Required: true
Name string `json:"name"`
// Redirect path | 跳转路径
// Required: true
Redirect string `json:"redirect"`
// The component path | 组件路径
// Required: true
Component string `json:"component"`
// The sorting number | 排序编号
// Required: true
OrderNo uint32 `json:"orderNo"`
// Wether disabled | 是否禁用菜单
// Required: true
Disabled bool `json:"disabled"`
// in: body
Meta
Expand All @@ -129,14 +137,19 @@ type (
// swagger:model CreateOrUpdateMenuParamReq
CreateOrUpdateMenuParamReq {
// ID
// Required: true
ID uint32 `json:"id"`
// Menu ID | 菜单ID
// Required: true
MenuId uint32 `json:"menuId"`
// Data Type | 数据类型
// Required: true
DataType string `json:"dataType"`
// Key | 键
// Required: true
Key string `json:"key"`
// Value | 值
// Required: true
Value string `json:"value"`
}

Expand Down
41 changes: 31 additions & 10 deletions api/api_desc/user.api
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ type (
// swagger:model LoginReq
LoginReq {
// User Name | 用户名
// Required: true
Username string `json:"username"`
// Password | 密码
// Required: true
Password string `json:"password"`
// Captcha Id which store in redis | 验证码编号, 存在redis中
// Required: true
CaptchaId string `json:"captchaId"`
// The Captcha which users input | 用户输入的验证码
// Required: true
Captcha string `json:"captcha"`
}

Expand Down Expand Up @@ -55,16 +59,16 @@ type (
// swagger:model ProfileReq
ProfileReq {
// user's nickname | 用户的昵称
// required: true
// Required: true
Nickname string `json:"nickname"`
// The user's avatar path | 用户的头像路径
// required: true
// Required: true
Avatar string `json:"avatar"`
// User's mobile phone number | 用户的手机号码
// required: true
// Required: true
Mobile string `json:"mobile"`
// The user's email address | 用户的邮箱
// required: true
// Required: true
Email string `json:"email"`
}

Expand All @@ -81,45 +85,56 @@ type (
// swagger:model RegisterReq
RegisterReq {
// User Name | 用户名
// Required: true
Username string `json:"username"`
// Password | 密码
// Required: true
Password string `json:"password"`
// Captcha Id which store in redis | 验证码编号, 存在redis中
// Required: true
CaptchaId string `json:"captchaId"`
// The Captcha which users input | 用户输入的验证码
// Required: true
Captcha string `json:"captcha"`
// The user's email address | 用户的邮箱
// Required: true
Email string `json:"email"`
}

// change user's password request | 修改密码请求参数
// swagger:model ChangePasswordReq
ChangePasswordReq {
// User's old password | 用户旧密码
// required: true
// Required: true
OldPassword string `json:"oldPassword"`
// User's new password | 用户新密码
// required: true
// Required: true
NewPassword string `json:"newPassword"`
}

// modify user's information request | 修改用户信息参数
// swagger:model ModifyInfoReq
// modify user's information request
// 修改用户信息参数
ModifyInfoReq {
// User's UUID | 用户的UUID
// Required: true
UUID string `json:"UUID"`
// User's nickname | 用户的昵称
// Required: true
Nickname string `json:"nickname"`
// User's mobile phone number | 用户的手机号码
// Required: true
Mobile string `json:"mobile"`
// User's role id | 用户的角色Id
// Required: true
RoleId uint32 `json:"roleId"`
// The user's email address | 用户的邮箱
// Required: true
Email string `json:"email"`
// The user's avatar path | 用户的头像路径
// Required: true
Avatar string `json:"avatar"`
// The user's layout mode | 用户的布局
// Required: true
SideMode string `json:"sideMode"`
}

Expand Down Expand Up @@ -224,23 +239,29 @@ type (
Status int32 `json:"status"`
}

// Get user list request
// Get user list request | 获取用户列表请求参数
// swagger:model GetUserListReq
// 获取用户列表请求参数
GetUserListReq {
// Page number | 第几页
// Required: true
Page uint64 `json:"page"`
// Page size | 单页数据行数
// Required: true
PageSize uint64 `json:"pageSize"`
// User Name | 用户名
// Required: true
Username string `json:"username"`
// User's nickname | 用户的昵称
// Required: true
Nickname string `json:"nickname"`
// User's mobile phone number | 用户的手机号码
// Required: true
Mobile string `json:"mobile"`
// The user's email address | 用户的邮箱
// Required: true
Email string `json:"email"`
// User's role ID | 用户的角色Id
// Required: true
RoleId uint64 `json:"roleId"`
}
)
Expand Down
54 changes: 44 additions & 10 deletions api/internal/types/types.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 5e283cb

Please sign in to comment.