【更新】更新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 api
import (
"github.com/XM-GO/PandaKit/model"
"github.com/XM-GO/PandaKit/restfulx"
"github.com/XM-GO/PandaKit/utils"
"pandax/apps/log/entity"
@@ -20,11 +21,11 @@ func (l *LogJobApi) GetJobLogList(rc *restfulx.ReqCtx) {
status := restfulx.QueryParam(rc, "status")
list, total := l.LogJobApp.FindListPage(pageNum, pageSize, entity.LogJob{Name: name, JobGroup: jobGroup, Status: status})
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,
}
}

View File

@@ -1,6 +1,7 @@
package api
import (
"github.com/XM-GO/PandaKit/model"
"github.com/XM-GO/PandaKit/restfulx"
"github.com/XM-GO/PandaKit/utils"
"pandax/apps/log/entity"
@@ -17,11 +18,11 @@ func (l *LogLoginApi) GetLoginLogList(rc *restfulx.ReqCtx) {
loginLocation := restfulx.QueryParam(rc, "loginLocation")
username := restfulx.QueryParam(rc, "username")
list, total := l.LogLoginApp.FindListPage(pageNum, pageSize, entity.LogLogin{LoginLocation: loginLocation, Username: username})
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,
}
}

View File

@@ -1,6 +1,7 @@
package api
import (
"github.com/XM-GO/PandaKit/model"
"github.com/XM-GO/PandaKit/restfulx"
"github.com/XM-GO/PandaKit/utils"
"log"
@@ -19,11 +20,11 @@ func (l *LogOperApi) GetOperLogList(rc *restfulx.ReqCtx) {
operName := restfulx.QueryParam(rc, "operName")
title := restfulx.QueryParam(rc, "title")
list, total := l.LogOperApp.FindListPage(pageNum, pageSize, entity.LogOper{BusinessType: businessType, OperName: operName, Title: title})
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,
}
}

View File

@@ -1,11 +1,11 @@
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/log/api"
"pandax/apps/log/entity"
"pandax/apps/log/services"
)
@@ -23,9 +23,14 @@ func InitJobLogRouter(container *restful.Container) {
restfulx.NewReqCtx(request, response).WithLog("获取操作日志列表").Handle(s.GetJobLogList)
}).
Doc("获取操作日志列表").
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("name", "name").DataType("string")).
Param(ws.QueryParameter("jobGroup", "jobGroup").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Writes([]entity.LogJob{}).
Returns(200, "OK", []entity.LogJob{}))
Writes(model.ResultPage{}).
Returns(200, "OK", model.ResultPage{}))
ws.Route(ws.DELETE("/{logId}").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("删除操作日志信息").Handle(s.DeleteJobLog)

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,9 +24,13 @@ func InitLoginLogRouter(container *restful.Container) {
restfulx.NewReqCtx(request, response).WithLog("获取登录日志列表").Handle(s.GetLoginLogList)
}).
Doc("获取登录日志列表").
Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
Param(ws.QueryParameter("loginLocation", "loginLocation").DataType("string")).
Param(ws.QueryParameter("username", "username").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Writes([]entity.LogLogin{}).
Returns(200, "OK", []entity.LogLogin{}))
Writes(model.ResultPage{}).
Returns(200, "OK", model.ResultPage{}))
ws.Route(ws.GET("/{infoId}").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("获取登录日志信息").Handle(s.GetLoginLog)

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,9 +24,14 @@ func InitOperLogRouter(container *restful.Container) {
restfulx.NewReqCtx(request, response).WithLog("获取操作日志列表").Handle(s.GetOperLogList)
}).
Doc("获取操作日志列表").
Param(ws.QueryParameter("pageNum", "页数").Required(true).DataType("int")).
Param(ws.QueryParameter("pageSize", "每页条数").Required(true).DataType("int")).
Param(ws.QueryParameter("businessType", "businessType").DataType("string")).
Param(ws.QueryParameter("operName", "operName").DataType("string")).
Param(ws.QueryParameter("title", "title").DataType("string")).
Metadata(restfulspec.KeyOpenAPITags, tags).
Writes([]entity.LogOper{}).
Returns(200, "OK", []entity.LogOper{}))
Writes(model.ResultPage{}).
Returns(200, "OK", model.ResultPage{}))
ws.Route(ws.GET("/{operId}").To(func(request *restful.Request, response *restful.Response) {
restfulx.NewReqCtx(request, response).WithLog("获取操作日志信息").Handle(s.GetOperLog)