public/PandaX
1
0
Fork 0
mirror of https://gitee.com/XM-GO/PandaX.git synced 2026-04-24 03:18:35 +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

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)