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

@@ -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"
@@ -27,9 +28,14 @@ func InitResOssRouter(container *restful.Container) {
restfulx.NewReqCtx(request, response).WithLog("获取ResOsses分页列表").Handle(s.GetResOssesList)
}).
Doc("获取ResOsses分页列表").
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("category", "category").DataType("string")).
Param(ws.QueryParameter("ossCode", "ossCode").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Writes([]entity.ResOss{}).
Returns(200, "OK", []entity.ResOss{}))
Writes(model.ResultPage{}).
Returns(200, "OK", model.ResultPage{}))
ws.Route(ws.GET("/{ossId}").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("获取ResOsses信息").Handle(s.GetResOsses)
@@ -46,7 +52,7 @@ func InitResOssRouter(container *restful.Container) {
}).
Doc("添加ResOsses信息").
Metadata(restfulspec.KeyOpenAPITags, tags).
Reads(entity.ResOss{})) // from the request
Reads(entity.ResOss{}))
ws.Route(ws.PUT("").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("修改ResOsses信息").Handle(s.UpdateResOsses)
@@ -66,6 +72,7 @@ func InitResOssRouter(container *restful.Container) {
restfulx.NewReqCtx(request, response).WithLog("测试文件上传").Handle(s.UplaodResOsses)
}).
Doc("测试文件上传").
Param(ws.QueryParameter("ossCode", "ossCode").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags))
ws.Route(ws.PUT("/changeStatus").To(func(request *restful.Request, response *restful.Response) {