【更新】更新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

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