public/PandaX
1
0
Fork 0
mirror of https://gitee.com/XM-GO/PandaX.git synced 2026-04-27 05:29:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

【更新】更新swagger文档

Browse Source
This commit is contained in:
PandaGoAdmin
2022-08-04 16:57:18 +08:00
parent 6db51fb2c9
commit 6d893f7c4e
39 changed files with 439 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
apps/system/router/api.go
View File

@@ -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{}))

18
apps/system/router/config.go
View File

@@ -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)

17
apps/system/router/dept.go
View File

@@ -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)

23
apps/system/router/dict.go
View File

@@ -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)

17
apps/system/router/menu.go
View File

@@ -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{}))

13
apps/system/router/notice.go
View File

@@ -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)

18
apps/system/router/post.go
View File

@@ -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)

18
apps/system/router/role.go
View File

@@ -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)

13
apps/system/router/tenant.go
View File

@@ -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)

41
apps/system/router/user.go
View File

@@ -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)