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

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