文档

测试

list

websocket测试

POST

http://idea.welikedian.com/snack/product/list

接口描述

商品搜索及动态排序，可以通过关键字或者类目进行搜索

请求参数

参数名

类型

描述

必填

categoryId

number

类目id

可选

keyWord

string

关键字

可选

pageNum

number

页数，默认为1

必填

pageSize

number

每页最大容纳几条数据，默认为10

必填

orderBy

string

排序参数，如按价格升序，price_asc

可选

成功响应参数

参数名

类型

描述

必填

code

number

响应码

必填

data

object

数据字典

必填

pageNum

number

当前页

必填

pageSize

number

每页的数据数量

必填

size

number

当前页的数据数量

必填

startRow

number

当前页面第一个元素在数据库中的行号

必填

endRow

number

当前页面最后一个元素在数据库中的行号

必填

total

number

数据库中总记录数

必填

pages

number

总页数

必填

list

array

结果集(每页显示的数据)

必填

productId

number

商品id

必填

categoryId

number

类目id

必填

name

string

商品名称

必填

subtitle

string

商品副标题

必填

mainImgUrl

string

商品主图

必填

price

number

商品价格,单位：元保留两位小数

必填

prePage

number

前一页页数

必填

nextPage

number

后一页页数

必填

isFirstPage

boolean

当前页是否是第一页

必填

isLastPage

boolean

当前页是否是最后一页

必填

hasPreviousPage

boolean

是否有上一页

必填

hasNextPage

boolean

是否有下一页

必填

navigatePages

number

导航页码数

可选

navigatepageNums

array

所有导航页号

可选

成功返回示例

```json { "code": 0, "data": { "pageNum": 1, "pageSize": 10, "size": 2, "startRow": 1, "endRow": 2, "total": 2, "pages": 1, "list": [ { "productId": 1, "categoryId": 3, "name": "芹菜", "subtitle": "促销", "mainImgUrl": "http://xxx.png", "status": 1, "price": 1.32 } ], "prePage": 0, "nextPage": 0, "isFirstPage": true, "isLastPage": true, "hasPreviousPage": false, "hasNextPage": false, "navigatePages": 0, "navigatepageNums": [ 1 ] } } ```

失败相应参数

参数名

类型

描述

必填

code

number

响应状态码，非0则表示出现错误，具体看全局返回码

必填

msg

string

错误返回信息

必填

上一篇 renct

nextDoc detail