【更新】更新swagger文档

apps/system/api/api.go

@@ -2,9 +2,9 @@ package api
 
 import (
 	"github.com/XM-GO/PandaKit/casbin"
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
-	"log"
 	entity "pandax/apps/system/entity"
 	services "pandax/apps/system/services"
 	"strconv"
@@ -17,7 +17,6 @@ type SystemApiApi struct {
 func (s *SystemApiApi) CreateApi(rc *restfulx.ReqCtx) {
 	var api entity.SysApi
 	restfulx.BindQuery(rc, &api)
-	log.Println(api)
 	s.ApiApp.Insert(api)
 }
 
@@ -35,11 +34,11 @@ func (s *SystemApiApi) GetApiList(rc *restfulx.ReqCtx) {
 	apiGroup := rc.Request.QueryParameter("apiGroup")
 	api := entity.SysApi{Path: path, Description: description, Method: method, ApiGroup: apiGroup}
 	list, total := s.ApiApp.FindListPage(pageNum, pageSize, api)
-	rc.ResData = map[string]any{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 

apps/system/api/config.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	"github.com/XM-GO/PandaKit/biz"
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
 	entity "pandax/apps/system/entity"
@@ -21,11 +22,11 @@ func (p *ConfigApi) GetConfigList(rc *restfulx.ReqCtx) {
 	config := entity.SysConfig{ConfigName: configName, ConfigKey: configKey, ConfigType: configType}
 	list, total := p.ConfigApp.FindListPage(pageNum, pageSize, config)
 
-	rc.ResData = map[string]any{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 

apps/system/api/dept.go

@@ -6,6 +6,7 @@ import (
 	"github.com/XM-GO/PandaKit/biz"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
+	"pandax/apps/system/api/vo"
 	"pandax/apps/system/entity"
 	"pandax/apps/system/services"
 	"pandax/pkg/global"
@@ -29,9 +30,9 @@ func (m *DeptApi) GetDeptTreeRoleSelect(rc *restfulx.ReqCtx) {
 	if roleId != 0 {
 		deptIds = m.RoleApp.GetRoleDeptId(entity.SysRole{RoleId: int64(roleId)})
 	}
-	rc.ResData = map[string]any{
-		"depts":       result,
-		"checkedKeys": deptIds,
+	rc.ResData = vo.DeptTreeVo{
+		Depts:       result,
+		CheckedKeys: deptIds,
 	}
 }
 

apps/system/api/dict.go

@@ -3,6 +3,7 @@ package api
 import (
 	"fmt"
 	"github.com/XM-GO/PandaKit/biz"
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
 	entity "pandax/apps/system/entity"
@@ -23,11 +24,11 @@ func (p *DictApi) GetDictTypeList(rc *restfulx.ReqCtx) {
 	dictType := restfulx.QueryParam(rc, "dictType")
 
 	list, total := p.DictType.FindListPage(pageNum, pageSize, entity.SysDictType{Status: status, DictName: dictName, DictType: dictType})
-	rc.ResData = map[string]any{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 

apps/system/api/menu.go

@@ -4,6 +4,7 @@ import (
 	"github.com/XM-GO/PandaKit/biz"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
+	"pandax/apps/system/api/vo"
 	entity "pandax/apps/system/entity"
 	services "pandax/apps/system/services"
 )
@@ -35,9 +36,9 @@ func (m *MenuApi) GetMenuTreeRoleSelect(rc *restfulx.ReqCtx) {
 	if roleId != 0 {
 		menuIds = m.RoleApp.GetRoleMeunId(entity.SysRole{RoleId: int64(roleId)})
 	}
-	rc.ResData = map[string]any{
-		"menus":       result,
-		"checkedKeys": menuIds,
+	rc.ResData = vo.MenuTreeVo{
+		Menus:       *result,
+		CheckedKeys: menuIds,
 	}
 }
 
@@ -72,9 +73,9 @@ func (m *MenuApi) InsertMenu(rc *restfulx.ReqCtx) {
 	m.MenuApp.Insert(menu)
 	permis := m.RoleMenuApp.GetPermis(rc.LoginAccount.RoleId)
 	menus := m.MenuApp.SelectMenuRole(rc.LoginAccount.RoleKey)
-	rc.ResData = map[string]any{
-		"permissions": permis,
-		"menus":       Build(*menus),
+	rc.ResData = vo.MenuPermisVo{
+		Menus:       Build(*menus),
+		Permissions: permis,
 	}
 }
 
@@ -85,9 +86,9 @@ func (m *MenuApi) UpdateMenu(rc *restfulx.ReqCtx) {
 	m.MenuApp.Update(menu)
 	permis := m.RoleMenuApp.GetPermis(rc.LoginAccount.RoleId)
 	menus := m.MenuApp.SelectMenuRole(rc.LoginAccount.RoleKey)
-	rc.ResData = map[string]any{
-		"permissions": permis,
-		"menus":       Build(*menus),
+	rc.ResData = vo.MenuPermisVo{
+		Menus:       Build(*menus),
+		Permissions: permis,
 	}
 }
 

apps/system/api/notice.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
 	"pandax/apps/system/entity"
@@ -28,11 +29,11 @@ func (p *NoticeApi) GetNoticeList(rc *restfulx.ReqCtx) {
 	notice := entity.SysNotice{NoticeType: noticeType, Title: title, DeptIds: ids}
 	list, total := p.NoticeApp.FindListPage(pageNum, pageSize, notice)
 
-	rc.ResData = map[string]any{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 

apps/system/api/post.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"github.com/XM-GO/PandaKit/biz"
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
 	"pandax/apps/system/entity"
@@ -33,11 +34,11 @@ func (p *PostApi) GetPostList(rc *restfulx.ReqCtx) {
 
 	list, total := p.PostApp.FindListPage(pageNum, pageSize, post)
 
-	rc.ResData = map[string]any{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 

apps/system/api/role.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"github.com/XM-GO/PandaKit/biz"
 	"github.com/XM-GO/PandaKit/casbin"
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
 	entity "pandax/apps/system/entity"
@@ -35,11 +36,11 @@ func (r *RoleApi) GetRoleList(rc *restfulx.ReqCtx) {
 
 	list, total := r.RoleApp.FindListPage(pageNum, pageSize, role)
 
-	rc.ResData = map[string]any{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 

apps/system/api/tenant.go

@@ -6,6 +6,7 @@ package api
  * @Date 2022/7/14 17:55
  **/
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	"github.com/XM-GO/PandaKit/utils"
 	"pandax/apps/system/entity"
@@ -23,11 +24,11 @@ func (p *SysTenantsApi) GetSysTenantsList(rc *restfulx.ReqCtx) {
 
 	list, total := p.SysTenantsApp.FindListPage(pageNum, pageSize, data)
 
-	rc.ResData = map[string]interface{}{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 

apps/system/api/user.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/token"
 	"github.com/dgrijalva/jwt-go"
 	"github.com/emicklei/go-restful/v3"
@@ -39,7 +40,7 @@ type UserApi struct {
 // GenerateCaptcha 获取验证码
 func (u *UserApi) GenerateCaptcha(request *restful.Request, response *restful.Response) {
 	id, image := captcha.Generate()
-	response.WriteEntity(map[string]any{"base64Captcha": image, "captchaId": id})
+	response.WriteEntity(vo.CaptchaVo{Base64Captcha: image, CaptchaId: id})
 }
 
 // RefreshToken 刷新token
@@ -48,7 +49,10 @@ func (u *UserApi) RefreshToken(rc *restfulx.ReqCtx) {
 	j := token.NewJWT("", []byte(global.Conf.Jwt.Key), jwt.SigningMethodHS256)
 	token, err := j.RefreshToken(tokenStr)
 	biz.ErrIsNil(err, "刷新token失败")
-	rc.ResData = map[string]any{"token": token, "expire": time.Now().Unix() + global.Conf.Jwt.ExpireTime}
+	rc.ResData = vo.TokenVo{
+		Token:  token,
+		Expire: time.Now().Unix() + global.Conf.Jwt.ExpireTime,
+	}
 }
 
 // Login 用户登录
@@ -77,9 +81,9 @@ func (u *UserApi) Login(rc *restfulx.ReqCtx) {
 	})
 	biz.ErrIsNil(err, "生成Token失败")
 
-	rc.ResData = map[string]any{
-		"token":  token,
-		"expire": time.Now().Unix() + global.Conf.Jwt.ExpireTime,
+	rc.ResData = vo.TokenVo{
+		Token:  token,
+		Expire: time.Now().Unix() + global.Conf.Jwt.ExpireTime,
 	}
 
 	var loginLog logEntity.LogLogin
@@ -111,11 +115,11 @@ func (u *UserApi) Auth(rc *restfulx.ReqCtx) {
 	permis := u.RoleMenuApp.GetPermis(role.RoleId)
 	menus := u.MenuApp.SelectMenuRole(role.RoleKey)
 
-	rc.ResData = map[string]any{
-		"user":        userData,
-		"role":        role,
-		"permissions": permis,
-		"menus":       Build(*menus),
+	rc.ResData = vo.AuthVo{
+		User:        *userData,
+		Role:        *role,
+		Permissions: permis,
+		Menus:       Build(*menus),
 	}
 }
 
@@ -156,11 +160,11 @@ func (u *UserApi) GetSysUserList(rc *restfulx.ReqCtx) {
 	}
 	list, total := u.UserApp.FindListPage(pageNum, pageSize, user)
 
-	rc.ResData = map[string]any{
-		"data":     list,
-		"total":    total,
-		"pageNum":  pageNum,
-		"pageSize": pageSize,
+	rc.ResData = model.ResultPage{
+		Total:    total,
+		PageNum:  int64(pageNum),
+		PageSize: int64(pageNum),
+		Data:     list,
 	}
 }
 
@@ -184,13 +188,13 @@ func (u *UserApi) GetSysUserProfile(rc *restfulx.ReqCtx) {
 	roleIds := make([]int64, 0)
 	roleIds = append(roleIds, rc.LoginAccount.RoleId)
 
-	rc.ResData = map[string]any{
-		"data":    user,
-		"postIds": postIds,
-		"roleIds": roleIds,
-		"roles":   roleList,
-		"posts":   postList,
-		"dept":    deptList,
+	rc.ResData = vo.UserProfileVo{
+		Data:    user,
+		PostIds: postIds,
+		RoleIds: roleIds,
+		Roles:   *roleList,
+		Posts:   *postList,
+		Dept:    *deptList,
 	}
 }
 
@@ -244,12 +248,12 @@ func (u *UserApi) GetSysUser(rc *restfulx.ReqCtx) {
 	}
 	posts := u.PostApp.FindList(post)
 
-	rc.ResData = map[string]any{
-		"data":    result,
-		"postIds": result.PostIds,
-		"roleIds": result.RoleIds,
-		"roles":   roles,
-		"posts":   posts,
+	rc.ResData = vo.UserVo{
+		Data:    result,
+		PostIds: result.PostIds,
+		RoleIds: result.RoleIds,
+		Roles:   *roles,
+		Posts:   *posts,
 	}
 }
 
@@ -266,10 +270,10 @@ func (u *UserApi) GetSysUserInit(rc *restfulx.ReqCtx) {
 		post.TenantId = rc.LoginAccount.TenantId
 	}
 	posts := u.PostApp.FindList(post)
-	mp := make(map[string]any, 2)
-	mp["roles"] = roles
-	mp["posts"] = posts
-	rc.ResData = mp
+	rc.ResData = vo.UserRolePost{
+		Roles: *roles,
+		Posts: *posts,
+	}
 }
 
 // GetUserRolePost 获取添加用户角色和职位
@@ -289,10 +293,10 @@ func (u *UserApi) GetUserRolePost(rc *restfulx.ReqCtx) {
 		po := u.PostApp.FindOne(kgo.KConv.Str2Int64(postId))
 		posts = append(posts, *po)
 	}
-	mp := make(map[string]any, 2)
-	mp["roles"] = roles
-	mp["posts"] = posts
-	rc.ResData = mp
+	rc.ResData = vo.UserRolePost{
+		Roles: roles,
+		Posts: posts,
+	}
 }
 
 // InsertSysUser 创建用户

apps/system/api/vo/systemVo.go

@@ -0,0 +1,63 @@
+package vo
+
+import "pandax/apps/system/entity"
+
+/**
+ * @Description
+ * @Author 熊猫
+ * @Date 2022/8/4 15:25
+ **/
+
+type DeptTreeVo struct {
+	Depts       []entity.DeptLable `json:"depts"`
+	CheckedKeys []int64            `json:"checkedKeys"`
+}
+
+type MenuTreeVo struct {
+	Menus       []entity.MenuLable `json:"menus"`
+	CheckedKeys []int64            `json:"checkedKeys"`
+}
+
+type MenuPermisVo struct {
+	Menus       []RouterVo `json:"menus"`
+	Permissions []string   `json:"permissions"`
+}
+
+type CaptchaVo struct {
+	Base64Captcha string `json:"base64Captcha"`
+	CaptchaId     string `json:"captchaId"`
+}
+
+type TokenVo struct {
+	Token  string `json:"token"`
+	Expire int64  `json:"expire"`
+}
+
+type AuthVo struct {
+	User        entity.SysUserView `json:"user"`
+	Role        entity.SysRole     `json:"role"`
+	Permissions []string           `json:"permissions"`
+	Menus       []RouterVo         `json:"menus"`
+}
+
+type UserProfileVo struct {
+	Data    any              `json:"data"`
+	PostIds []int64          `json:"postIds"`
+	RoleIds []int64          `json:"roleIds"`
+	Roles   []entity.SysRole `json:"roles"`
+	Posts   []entity.SysPost `json:"posts"`
+	Dept    []entity.SysDept `json:"dept"`
+}
+
+type UserVo struct {
+	Data    any              `json:"data"`
+	PostIds string           `json:"postIds"`
+	RoleIds string           `json:"roleIds"`
+	Roles   []entity.SysRole `json:"roles"`
+	Posts   []entity.SysPost `json:"posts"`
+}
+
+type UserRolePost struct {
+	Roles []entity.SysRole `json:"roles"`
+	Posts []entity.SysPost `json:"posts"`
+}

apps/system/router/api.go

@@ -2,6 +2,7 @@ package router
 
 import (
 	"github.com/XM-GO/PandaKit/casbin"
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
@@ -24,8 +25,14 @@ func InitApiRouter(container *restful.Container) {
 	}).
 		Doc("获取api分页列表").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysApi{}).
-		Returns(200, "OK", []entity.SysApi{}))
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("path", "路径").DataType("string")).
+		Param(ws.QueryParameter("description", "描述").DataType("string")).
+		Param(ws.QueryParameter("method", "方法").DataType("string")).
+		Param(ws.QueryParameter("apiGroup", "API组").DataType("string")).
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.GET("/all").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取所有api").Handle(s.GetAllApis)
@@ -39,6 +46,7 @@ func InitApiRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取角色拥有的api权限").Handle(s.GetPolicyPathByRoleId)
 	}).
 		Doc("获取角色拥有的api权限").
+		Param(ws.QueryParameter("roleKey", "校色key").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Writes([]casbin.CasbinRule{}).
 		Returns(200, "OK", []casbin.CasbinRule{}))

apps/system/router/config.go

@@ -1,6 +1,7 @@
 package router
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
@@ -23,13 +24,20 @@ func InitConfigRouter(container *restful.Container) {
 	}).
 		Doc("获取配置分页列表").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysConfig{}).
-		Returns(200, "OK", []entity.SysConfig{}))
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("configName", "configName").DataType("string")).
+		Param(ws.QueryParameter("configKey", "configKey").DataType("string")).
+		Param(ws.QueryParameter("configType", "configType").DataType("string")).
+		Metadata(restfulspec.KeyOpenAPITags, tags).
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.GET("/configKey").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取配置列表通过ConfigKey").Handle(s.GetConfigListByKey)
 	}).
 		Doc("获取配置列表通过ConfigKey").
+		Param(ws.QueryParameter("configKey", "configKey").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Writes([]entity.SysConfig{}).
 		Returns(200, "OK", []entity.SysConfig{}))
@@ -38,9 +46,9 @@ func InitConfigRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取配置信息").Handle(s.GetConfig)
 	}).
 		Doc("获取配置信息").
-		Param(ws.PathParameter("configId", "configId").DataType("int").DefaultValue("1")).
+		Param(ws.PathParameter("configId", "configId").DataType("int")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysConfig{}). // on the response
+		Writes(entity.SysConfig{}).
 		Returns(200, "OK", entity.SysConfig{}).
 		Returns(404, "Not Found", nil))
 
@@ -49,7 +57,7 @@ func InitConfigRouter(container *restful.Container) {
 	}).
 		Doc("添加配置信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysConfig{})) // from the request
+		Reads(entity.SysConfig{}))
 
 	ws.Route(ws.PUT("").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("修改配置信息").Handle(s.UpdateConfig)

apps/system/router/dept.go

@@ -5,6 +5,7 @@ import (
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
 	"pandax/apps/system/api"
+	"pandax/apps/system/api/vo"
 	"pandax/apps/system/entity"
 	"pandax/apps/system/services"
 )
@@ -26,21 +27,29 @@ func InitDeptRouter(container *restful.Container) {
 		Doc("获取角色部门树").
 		Param(ws.PathParameter("roleId", "角色Id").DataType("int").DefaultValue("1")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(map[string]any{}). // on the response
+		Writes(vo.DeptTreeVo{}).
+		Returns(200, "OK", vo.DeptTreeVo{}).
 		Returns(404, "Not Found", nil))
 
 	ws.Route(ws.GET("/deptTree").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取所有部门树").Handle(s.GetDeptTree)
 	}).
 		Doc("获取所有部门树").
+		Param(ws.QueryParameter("deptName", "deptName").DataType("string")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("deptId", "deptId").DataType("int")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysDept{}). // on the response
+		Writes([]entity.SysDept{}).
+		Returns(200, "OK", []entity.SysDept{}).
 		Returns(404, "Not Found", nil))
 
 	ws.Route(ws.GET("/list").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取部门列表").Handle(s.GetDeptList)
 	}).
 		Doc("获取部门列表").
+		Param(ws.QueryParameter("deptName", "deptName").DataType("string")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("deptId", "deptId").DataType("int")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Writes([]entity.SysDept{}).
 		Returns(200, "OK", []entity.SysDept{}))
@@ -60,14 +69,14 @@ func InitDeptRouter(container *restful.Container) {
 	}).
 		Doc("添加部门信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysDept{})) // from the request
+		Reads(entity.SysDept{}))
 
 	ws.Route(ws.PUT("").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("修改部门信息").Handle(s.UpdateDept)
 	}).
 		Doc("修改部门信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysDept{})) // from the request
+		Reads(entity.SysDept{}))
 
 	ws.Route(ws.DELETE("/{deptId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("删除部门信息").Handle(s.DeleteDept)

apps/system/router/dict.go

@@ -1,6 +1,7 @@
 package router
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
@@ -22,8 +23,14 @@ func InitDictRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取字典类型分页列表").Handle(s.GetDictTypeList)
 	}).
 		Doc("获取字典类型分页列表").
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("dictName", "dictName").DataType("string")).
+		Param(ws.QueryParameter("dictType", "dictType").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Returns(200, "OK", []entity.SysDictType{}))
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.GET("/type/{dictId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取字典类型信息").Handle(s.GetDictType)
@@ -31,7 +38,7 @@ func InitDictRouter(container *restful.Container) {
 		Doc("获取字典类型信息").
 		Param(ws.PathParameter("dictId", "Id").DataType("int").DefaultValue("1")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Returns(200, "OK", []entity.SysDictType{}))
+		Returns(200, "OK", entity.SysDictType{}))
 
 	ws.Route(ws.POST("/type").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("添加字典类型信息").Handle(s.InsertDictType)
@@ -58,12 +65,19 @@ func InitDictRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("导出字典类型信息").Handle(s.ExportDictType)
 	}).
 		Doc("导出字典类型信息").
+		Param(ws.QueryParameter("filename", "filename").DataType("string")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("dictName", "dictName").DataType("string")).
+		Param(ws.QueryParameter("dictType", "dictType").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags))
 
 	ws.Route(ws.GET("/data/list").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取字典数据分页列表").Handle(s.GetDictDataList)
 	}).
 		Doc("获取字典数据分页列表").
+		Param(ws.QueryParameter("dictLabel", "dictLabel").DataType("string")).
+		Param(ws.QueryParameter("dictType", "dictType").DataType("string")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Returns(200, "OK", []entity.SysDictData{}))
 
@@ -71,8 +85,9 @@ func InitDictRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取字典数据列表通过字典类型").Handle(s.GetDictDataListByDictType)
 	}).
 		Doc("获取字典数据列表通过字典类型").
+		Param(ws.QueryParameter("dictType", "dictType").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Returns(200, "OK", []entity.SysDictType{}))
+		Returns(200, "OK", []entity.SysDictData{}))
 
 	ws.Route(ws.GET("/data/{dictCode}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取字典数据信息").Handle(s.GetDictData)
@@ -80,7 +95,7 @@ func InitDictRouter(container *restful.Container) {
 		Doc("获取字典数据信息").
 		Param(ws.PathParameter("dictCode", "dictCode").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Returns(200, "OK", []entity.SysDictType{}))
+		Returns(200, "OK", entity.SysDictData{}))
 
 	ws.Route(ws.POST("/data").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("添加字典数据信息").Handle(s.InsertDictData)

apps/system/router/menu.go

@@ -5,6 +5,7 @@ import (
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
 	"pandax/apps/system/api"
+	"pandax/apps/system/api/vo"
 	"pandax/apps/system/entity"
 	"pandax/apps/system/services"
 )
@@ -25,16 +26,17 @@ func InitMenuRouter(container *restful.Container) {
 	}).
 		Doc("获取菜单树").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysMenu{}).
-		Returns(200, "OK", []entity.SysMenu{}))
+		Writes([]entity.MenuLable{}).
+		Returns(200, "OK", []entity.MenuLable{}))
 
 	ws.Route(ws.GET("/menuRole").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取角色菜单").Handle(s.GetMenuRole)
 	}).
 		Doc("获取角色菜单").
+		Param(ws.QueryParameter("roleKey", "roleKey").Required(true).DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.MenuRole{}).
-		Returns(200, "OK", []entity.MenuRole{}))
+		Writes([]vo.RouterVo{}).
+		Returns(200, "OK", []vo.RouterVo{}))
 
 	ws.Route(ws.GET("/roleMenuTreeSelect/{roleId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取角色菜单树").Handle(s.GetMenuTreeRoleSelect)
@@ -42,14 +44,15 @@ func InitMenuRouter(container *restful.Container) {
 		Doc("获取角色菜单树").
 		Param(ws.PathParameter("roleId", "Id").DataType("int").DefaultValue("1")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysMenu{}). // on the response
-		Returns(200, "OK", entity.SysMenu{}).
+		Writes(vo.MenuTreeVo{}).
+		Returns(200, "OK", vo.MenuTreeVo{}).
 		Returns(404, "Not Found", nil))
 
 	ws.Route(ws.GET("/menuPaths").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取角色菜单路径列表").Handle(s.GetMenuPaths)
 	}).
 		Doc("获取角色菜单").
+		Param(ws.QueryParameter("roleKey", "roleKey").Required(true).DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Writes([]entity.MenuPath{}).
 		Returns(200, "OK", []entity.MenuPath{}))
@@ -58,6 +61,8 @@ func InitMenuRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取菜单列表").Handle(s.GetMenuList)
 	}).
 		Doc("获取菜单列表").
+		Param(ws.QueryParameter("menuName", "menuName").DataType("string")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Writes([]entity.SysMenu{}).
 		Returns(200, "OK", []entity.SysMenu{}))

apps/system/router/notice.go

@@ -1,6 +1,7 @@
 package router
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
@@ -23,22 +24,26 @@ func InitNoticeRouter(container *restful.Container) {
 	}).
 		Doc("获取通知分页列表").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysNotice{}).
-		Returns(200, "OK", []entity.SysNotice{}))
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("noticeType", "noticeType").DataType("string")).
+		Param(ws.QueryParameter("title", "title").DataType("string")).
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.POST("").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("添加通知信息").Handle(s.InsertNotice)
 	}).
 		Doc("添加通知信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysNotice{})) // from the request
+		Reads(entity.SysNotice{}))
 
 	ws.Route(ws.PUT("").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("修改通知信息").Handle(s.UpdateNotice)
 	}).
 		Doc("修改通知信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysNotice{})) // from the request
+		Reads(entity.SysNotice{}))
 
 	ws.Route(ws.DELETE("/{noticeId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("删除通知信息").Handle(s.DeleteNotice)

apps/system/router/post.go

@@ -1,6 +1,7 @@
 package router
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
@@ -23,17 +24,22 @@ func InitPostRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取岗位分页列表").Handle(s.GetPostList)
 	}).
 		Doc("获取岗位分页列表").
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("postName", "postName").DataType("string")).
+		Param(ws.QueryParameter("postCode", "postCode").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysPost{}).
-		Returns(200, "OK", []entity.SysPost{}))
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.GET("/{postId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取岗位信息").Handle(s.GetPost)
 	}).
 		Doc("获取岗位信息").
-		Param(ws.PathParameter("postId", "Id").DataType("int").DefaultValue("1")).
+		Param(ws.PathParameter("postId", "Id").DataType("int")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysPost{}). // on the response
+		Writes(entity.SysPost{}).
 		Returns(200, "OK", entity.SysPost{}).
 		Returns(404, "Not Found", nil))
 
@@ -42,14 +48,14 @@ func InitPostRouter(container *restful.Container) {
 	}).
 		Doc("添加岗位信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysPost{})) // from the request
+		Reads(entity.SysPost{}))
 
 	ws.Route(ws.PUT("").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("修改岗位信息").Handle(s.UpdatePost)
 	}).
 		Doc("修改岗位信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysPost{})) // from the request
+		Reads(entity.SysPost{}))
 
 	ws.Route(ws.DELETE("/{postId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("删除岗位信息").Handle(s.DeletePost)

apps/system/router/role.go

@@ -1,6 +1,7 @@
 package router
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
@@ -24,9 +25,14 @@ func InitRoleRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取角色分页列表").Handle(s.GetRoleList)
 	}).
 		Doc("获取角色分页列表").
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("roleName", "roleName").DataType("string")).
+		Param(ws.QueryParameter("roleKey", "roleKey").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysRole{}).
-		Returns(200, "OK", []entity.SysRole{}))
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.GET("/{roleId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取角色信息").Handle(s.GetRole)
@@ -34,7 +40,7 @@ func InitRoleRouter(container *restful.Container) {
 		Doc("获取角色信息").
 		Param(ws.PathParameter("roleId", "Id").DataType("int").DefaultValue("1")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysRole{}). // on the response
+		Writes(entity.SysRole{}).
 		Returns(200, "OK", entity.SysRole{}).
 		Returns(404, "Not Found", nil))
 
@@ -43,7 +49,7 @@ func InitRoleRouter(container *restful.Container) {
 	}).
 		Doc("添加角色信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysRole{})) // from the request
+		Reads(entity.SysRole{}))
 
 	ws.Route(ws.PUT("").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("修改角色信息").Handle(s.UpdateRole)
@@ -77,6 +83,10 @@ func InitRoleRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("导出角色信息").Handle(s.ExportRole)
 	}).
 		Doc("导出角色信息").
+		Param(ws.QueryParameter("filename", "filename").DataType("string")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("roleName", "roleName").DataType("string")).
+		Param(ws.QueryParameter("roleKey", "roleKey").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags))
 
 	container.Add(ws)

apps/system/router/tenant.go

@@ -7,6 +7,7 @@ package router
  **/
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	"github.com/XM-GO/PandaKit/restfulx"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
@@ -27,9 +28,11 @@ func InitSysTenantRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("获取SysTenant分页列表").Handle(s.GetSysTenantsList)
 	}).
 		Doc("获取SysTenant分页列表").
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysTenants{}).
-		Returns(200, "OK", []entity.SysTenants{}))
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.GET("/lists").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取SysTenant列表").Handle(s.GetSysTenantsAll)
@@ -45,7 +48,7 @@ func InitSysTenantRouter(container *restful.Container) {
 		Doc("获取SysTenant信息").
 		Param(ws.PathParameter("tenantId", "租户Id").DataType("int").DefaultValue("1")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysTenants{}). // on the response
+		Writes(entity.SysTenants{}).
 		Returns(200, "OK", entity.SysTenants{}).
 		Returns(404, "Not Found", nil))
 
@@ -54,14 +57,14 @@ func InitSysTenantRouter(container *restful.Container) {
 	}).
 		Doc("添加SysTenant信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysTenants{})) // from the request
+		Reads(entity.SysTenants{}))
 
 	ws.Route(ws.PUT("").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("修改SysTenant信息").Handle(s.UpdateSysTenants)
 	}).
 		Doc("修改SysTenant信息").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysTenants{})) // from the request
+		Reads(entity.SysTenants{}))
 
 	ws.Route(ws.DELETE("/{tenantId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("删除SysTenant信息").Handle(s.DeleteSysTenants)

apps/system/router/user.go

@@ -1,9 +1,12 @@
 package router
 
 import (
+	"github.com/XM-GO/PandaKit/model"
 	restfulspec "github.com/emicklei/go-restful-openapi/v2"
 	"github.com/emicklei/go-restful/v3"
 	"pandax/apps/system/api"
+	"pandax/apps/system/api/form"
+	"pandax/apps/system/api/vo"
 	"pandax/apps/system/entity"
 	"pandax/apps/system/services"
 
@@ -32,7 +35,9 @@ func InitUserRouter(container *restful.Container) {
 	}).
 		Doc("登录").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Reads(entity.SysUser{})) // from the request
+		Reads(form.Login{}).
+		Writes(vo.TokenVo{}).
+		Returns(200, "OK", vo.TokenVo{}))
 
 	ws.Route(ws.POST("/logout").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithNeedToken(false).WithNeedCasbin(false).WithLog("退出登录").Handle(s.LogOut)
@@ -44,17 +49,23 @@ func InitUserRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithNeedCasbin(false).WithLog("认证信息").Handle(s.Auth)
 	}).
 		Doc("认证信息").
+		Param(ws.QueryParameter("username", "username").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysUser{}).
-		Returns(200, "OK", entity.SysUser{}))
+		Writes(vo.AuthVo{}).
+		Returns(200, "OK", vo.AuthVo{}))
 
 	ws.Route(ws.GET("/list").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("得到用户分页列表").Handle(s.GetSysUserList)
 	}).
 		Doc("得到用户分页列表").
+		Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("username", "username").DataType("string")).
+		Param(ws.QueryParameter("phone", "phone").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes([]entity.SysUser{}).
-		Returns(200, "OK", []entity.SysUser{}))
+		Writes(model.ResultPage{}).
+		Returns(200, "OK", model.ResultPage{}))
 
 	ws.Route(ws.GET("/getById/{userId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("获取用户信息").Handle(s.GetSysUser)
@@ -62,8 +73,8 @@ func InitUserRouter(container *restful.Container) {
 		Doc("获取用户信息").
 		Param(ws.PathParameter("userId", "Id").DataType("int").DefaultValue("1")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysUser{}). // on the response
-		Returns(200, "OK", entity.SysUser{}).
+		Writes(vo.UserVo{}).
+		Returns(200, "OK", vo.UserVo{}).
 		Returns(404, "Not Found", nil))
 
 	ws.Route(ws.GET("/getInit").To(func(request *restful.Request, response *restful.Response) {
@@ -71,8 +82,8 @@ func InitUserRouter(container *restful.Container) {
 	}).
 		Doc("获取初始化角色岗位信息(添加用户初始化)").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Writes(entity.SysUser{}). // on the response
-		Returns(200, "OK", entity.SysUser{}).
+		Writes(vo.UserRolePost{}). // on the response
+		Returns(200, "OK", vo.UserRolePost{}).
 		Returns(404, "Not Found", nil))
 
 	ws.Route(ws.GET("/getRoPo").To(func(request *restful.Request, response *restful.Response) {
@@ -80,7 +91,7 @@ func InitUserRouter(container *restful.Container) {
 	}).
 		Doc("获取用户角色岗位信息(添加用户初始化)").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Returns(200, "OK", entity.SysUser{}).
+		Returns(200, "OK", vo.UserRolePost{}).
 		Returns(404, "Not Found", nil))
 
 	ws.Route(ws.POST("").To(func(request *restful.Request, response *restful.Response) {
@@ -94,13 +105,15 @@ func InitUserRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("修改用户信息").Handle(s.UpdateSysUser)
 	}).
 		Doc("修改用户信息").
-		Metadata(restfulspec.KeyOpenAPITags, tags)) // from the request
+		Metadata(restfulspec.KeyOpenAPITags, tags).
+		Reads(entity.SysUser{}))
 
 	ws.Route(ws.PUT("/changeStatus").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("修改用户状态").Handle(s.UpdateSysUserStu)
 	}).
 		Doc("修改用户状态").
-		Metadata(restfulspec.KeyOpenAPITags, tags)) // from the request
+		Metadata(restfulspec.KeyOpenAPITags, tags).
+		Reads(entity.SysUser{}))
 
 	ws.Route(ws.DELETE("/{userId}").To(func(request *restful.Request, response *restful.Response) {
 		restfulx.NewReqCtx(request, response).WithLog("删除用户信息").Handle(s.DeleteSysUser)
@@ -125,6 +138,10 @@ func InitUserRouter(container *restful.Container) {
 		restfulx.NewReqCtx(request, response).WithLog("导出用户信息").Handle(s.ExportUser)
 	}).
 		Doc("导出用户信息").
+		Param(ws.QueryParameter("filename", "filename").DataType("string")).
+		Param(ws.QueryParameter("status", "status").DataType("string")).
+		Param(ws.QueryParameter("username", "username").DataType("string")).
+		Param(ws.QueryParameter("phone", "phone").DataType("string")).
 		Metadata(restfulspec.KeyOpenAPITags, tags))
 
 	container.Add(ws)