修复分页引擎文档
All checks were successful
Deploy on Tag / build-and-deploy (push) Successful in 24s

This commit is contained in:
wzj 2024-11-13 16:40:17 +08:00
parent 31878a4e77
commit 88fe343138
5 changed files with 56 additions and 2 deletions

View File

@ -54,7 +54,7 @@ func (c *ItemController) Detail(id uint) mvc.Result {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param type path string true "商品类型" // @Param type path string true "商品类型"
// @Param pagingParam query validate.PagingParam true "分页信息" // @Param pagingParam query validate.PagingParam false "分页信息"
// @Success 200 {object} []model.ItemModel "{["id":1],["id":2]}" // @Success 200 {object} []model.ItemModel "{["id":1],["id":2]}"
// @Failure 400 {object} map[string]interface{} "{"msg": "错误信息","code":0}" // @Failure 400 {object} map[string]interface{} "{"msg": "错误信息","code":0}"
// @Router /api/item/list/type/{type} [get] // @Router /api/item/list/type/{type} [get]
@ -97,7 +97,7 @@ func (c *ItemController) GetTypes() mvc.Result {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param keyword query string true "搜索关键字" // @Param keyword query string true "搜索关键字"
// @Param pagingParam query validate.PagingParam true "分页信息" // @Param pagingParam query validate.PagingParam false "分页信息"
// @Success 200 {object} []model.ItemModel "{["id":1],["id":2]}" // @Success 200 {object} []model.ItemModel "{["id":1],["id":2]}"
// @Failure 400 {object} map[string]interface{} "{"msg": "错误信息","code":0}" // @Failure 400 {object} map[string]interface{} "{"msg": "错误信息","code":0}"
// @Router /api/item/search [get] // @Router /api/item/search [get]

View File

@ -330,6 +330,7 @@ const docTemplate = `{
"type": "integer", "type": "integer",
"default": 1, "default": 1,
"example": 1, "example": 1,
"description": "@description 页码",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
@ -466,6 +467,24 @@ const docTemplate = `{
"name": "keyword", "name": "keyword",
"in": "query", "in": "query",
"required": true "required": true
},
{
"minimum": 0,
"type": "integer",
"default": 1,
"example": 1,
"description": "@description 页码",
"name": "page",
"in": "query"
},
{
"maximum": 50,
"type": "integer",
"default": 10,
"example": 10,
"description": "@description 每页数量",
"name": "pageSize",
"in": "query"
} }
], ],
"responses": { "responses": {

View File

@ -324,6 +324,7 @@
"type": "integer", "type": "integer",
"default": 1, "default": 1,
"example": 1, "example": 1,
"description": "@description 页码",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
@ -460,6 +461,24 @@
"name": "keyword", "name": "keyword",
"in": "query", "in": "query",
"required": true "required": true
},
{
"minimum": 0,
"type": "integer",
"default": 1,
"example": 1,
"description": "@description 页码",
"name": "page",
"in": "query"
},
{
"maximum": 50,
"type": "integer",
"default": 10,
"example": 10,
"description": "@description 每页数量",
"name": "pageSize",
"in": "query"
} }
], ],
"responses": { "responses": {

View File

@ -364,6 +364,7 @@ paths:
required: true required: true
type: string type: string
- default: 1 - default: 1
description: '@description 页码'
example: 1 example: 1
in: query in: query
minimum: 0 minimum: 0
@ -459,6 +460,20 @@ paths:
name: keyword name: keyword
required: true required: true
type: string type: string
- default: 1
description: '@description 页码'
example: 1
in: query
minimum: 0
name: page
type: integer
- default: 10
description: '@description 每页数量'
example: 10
in: query
maximum: 50
name: pageSize
type: integer
produces: produces:
- application/json - application/json
responses: responses:

View File

@ -18,6 +18,7 @@ type DeleteItemParam struct {
} }
type PagingParam struct { type PagingParam struct {
// @description 页码
Page int `json:"page" validate:"min=0" example:"1" default:"1"` Page int `json:"page" validate:"min=0" example:"1" default:"1"`
// @description 每页数量 // @description 每页数量
PageSize int `json:"pageSize" validate:"max=50" example:"10" default:"10"` PageSize int `json:"pageSize" validate:"max=50" example:"10" default:"10"`