子非鱼 客户端接口文档 - HelloSummer5/zifeiyu-client GitHub Wiki

全局变量

  • 域名还没下来，暂且用IP+端口吧：39.107.67.126:8002
  • 测试环境：
  • 正式环境：

postman相关请求传送门

1.首页列表

接口地址 请求类型 描述
/client/shops/list GET 首页列表

1.1 参数说明

参数名 数据类型 是否必须 参数说明
pageSize int 否 分页参数
pageNum int 否 分页参数
tipsId int 否 主题分类ID
priceId int 否 价格分类ID
pageId int 否 页数分类ID

1.2 返回值说明

参数名 数据类型 参数说明
sid String 模板编号
name String 模板名称
coverImgUrl String 模板主图
price int 价格
total int 总记录条数
pages int 总页数
  • 各种Id和分页参数参照参数说明。

1.3 返回值示例

{
    "msg": "success",
    "code": 0,
    "data": {
        "shops": [
            {
                "sid": "E0001",
                "name": "模板1啊😄",
                "coverImgUrl": "http://huaban.com/go/?pin_id=1722613351",
                "priceId": 1,
                "price": 10,
                "tipsId": 1,
                "pageId": 1
            }
        ],
        "total": 1,
        "pages": 1,
        "pageSize": 4,
        "pageNum": 1
    }
}

1.4 没有查询到相关信息

{
    "msg": "success",
    "code": 0,
    "data": {
        "shops": [],
        "total": 0,
        "pages": 0,
        "pageSize": 4,
        "pageNum": 1
    }
}

2.分类列表

接口地址 请求类型 描述
/client/classify/list GET 首页分类列表

2.1 参数说明

  • 暂无参数

2.2 返回值说明

参数名 数据类型 参数说明
priceList list 价格分类
pagesList list 页码分类
tipsList int 主题分类
id int 分类ID，模糊搜索用
name int 分类显示的名称

2.3 返回值示例

	
Response body
{
  "msg": "success",
  "code": 0,
  "data": {
    "priceList": [
      {
        "id": 1,
        "name": "10.0"
      },
      {
        "id": 2,
        "name": "20.0"
      }
    ],
    "pagesList": [
      {
        "id": 1,
        "name": "1~10"
      },
      {
        "id": 2,
        "name": "11~20"
      }
    ],
    "tipsList": [
      {
        "id": 1,
        "name": "个人博客"
      },
      {
        "id": 2,
        "name": "旅游"
      },
      {
        "id": 3,
        "name": "美食"
      }
    ]
  }
}