【更新】更新swagger文档

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

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