【更新】更新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,8 +1,10 @@
package api
import (
"github.com/XM-GO/PandaKit/model"
"github.com/XM-GO/PandaKit/restfulx"
"github.com/XM-GO/PandaKit/utils"
"pandax/apps/develop/api/vo"
"pandax/apps/develop/entity"
"pandax/apps/develop/gen"
"pandax/apps/develop/services"
@@ -21,11 +23,11 @@ func (g *GenTableApi) GetDBTableList(rc *restfulx.ReqCtx) {
tableName := restfulx.QueryParam(rc, "tableName")
list, total := g.GenTableApp.FindDbTablesListPage(pageNum, pageSize, entity.DBTables{TableName: tableName})
rc.ResData = map[string]any{
"data": list,
"total": total,
"pageNum": pageNum,
"pageSize": pageSize,
rc.ResData = model.ResultPage{
Total: total,
PageNum: int64(pageNum),
PageSize: int64(pageNum),
Data: list,
}
}
@@ -37,11 +39,11 @@ func (g *GenTableApi) GetTablePage(rc *restfulx.ReqCtx) {
tableComment := restfulx.QueryParam(rc, "tableComment")
list, total := g.GenTableApp.FindListPage(pageNum, pageSize, entity.DevGenTable{TableName: tableName, TableComment: tableComment})
rc.ResData = map[string]any{
"data": list,
"total": total,
"pageNum": pageNum,
"pageSize": pageSize,
rc.ResData = model.ResultPage{
Total: total,
PageNum: int64(pageNum),
PageSize: int64(pageNum),
Data: list,
}
}
@@ -49,20 +51,20 @@ func (g *GenTableApi) GetTablePage(rc *restfulx.ReqCtx) {
func (g *GenTableApi) GetTableInfo(rc *restfulx.ReqCtx) {
tableId := restfulx.PathParamInt(rc, "tableId")
result := g.GenTableApp.FindOne(entity.DevGenTable{TableId: int64(tableId)}, true)
mp := make(map[string]any)
mp["list"] = result.Columns
mp["info"] = result
rc.ResData = mp
rc.ResData = vo.TableInfoVo{
List: result.Columns,
Info: *result,
}
}
// GetTableInfoByName 获取表信息
func (g *GenTableApi) GetTableInfoByName(rc *restfulx.ReqCtx) {
tableName := restfulx.QueryParam(rc, "tableName")
result := g.GenTableApp.FindOne(entity.DevGenTable{TableName: tableName}, true)
mp := make(map[string]any)
mp["list"] = result.Columns
mp["info"] = result
rc.ResData = mp
rc.ResData = vo.TableInfoVo{
List: result.Columns,
Info: *result,
}
}
// GetTableTree 获取树表信息

View File

@@ -0,0 +1,14 @@
package vo
import "pandax/apps/develop/entity"
/**
* @Description
* @Author 熊猫
* @Date 2022/8/4 15:52
**/
type TableInfoVo struct {
List []entity.DevGenTableColumn `json:"list"`
Info entity.DevGenTable `json:"info"`
}

View File

@@ -1,10 +1,13 @@
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"
"pandax/apps/develop/api"
"pandax/apps/develop/api/vo"
"pandax/apps/develop/entity"
"pandax/apps/develop/services"
)
@@ -23,21 +26,21 @@ func InitGenTableRouter(container *restful.Container) {
}).
Doc("获取数据库列表").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "OK", []map[string]any{}))
Returns(200, "OK", model.ResultPage{}))
ws.Route(ws.GET("/list").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("获取表列表").Handle(s.GetTablePage)
}).
Doc("获取表列表").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "OK", []any{}))
Returns(200, "OK", model.ResultPage{}))
ws.Route(ws.GET("/info/tableName").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("获取表信息By tableName").Handle(s.GetTableInfoByName)
}).
Doc("获取表信息By tableName").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "OK", []any{}))
Returns(200, "OK", vo.TableInfoVo{}))
ws.Route(ws.GET("/info/{tableId}").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("获取表信息").Handle(s.GetTableInfo)
@@ -45,7 +48,7 @@ func InitGenTableRouter(container *restful.Container) {
Doc("获取表信息").
Param(ws.PathParameter("tenantId", "租户Id").DataType("int").DefaultValue("1")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "OK", map[string]any{}).
Returns(200, "OK", vo.TableInfoVo{}).
Returns(404, "Not Found", nil))
ws.Route(ws.GET("/tableTree").To(func(request *restful.Request, response *restful.Response) {
@@ -53,7 +56,7 @@ func InitGenTableRouter(container *restful.Container) {
}).
Doc("获取表树").
Metadata(restfulspec.KeyOpenAPITags, tags).
Returns(200, "OK", []any{}))
Returns(200, "OK", []entity.DevGenTable{}))
ws.Route(ws.POST("").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("新增表").Handle(s.Insert)