接口文档

110 阅读2分钟

二 、开局测试

2.1 测试请求1

2.1.1 请求地址

/test/first

2.1.2 请求方式

get

2.1.3 携带参数

2.1.4 响应数据

哇塞, 你已经成功使用 ajax 发送给我了一个请求, 这是我给你的回应, 我是一个字符串类型 _ !

2.2 测试请求2

2.2.1 请求地址

/test/second

2.2.2 请求方式

get

2.2.3 携带参数

2.2.4 响应数据

json 格式数据类型

{
    "message": "我已经接受到了你的请求, 这是我给你的回应, 我是一个 json 格式",
    "tips": "后端返回给前端的数据",
    "code": 1,
    "age": 18
}

2.3 测试请求3

2.3.1 请求地址

/test/third

2.3.2 请求方式

get

2.3.3 携带参数

参数名称是否必填数据类型默认值参数介绍
name必填string--
age必填number--

2.3.4 响应数据

json 格式数据

{
    "message": "我接收到了你的请求, 你的请求方式是 GET, 并且正确携带了 'name' 和 'age' 参数给我 ! <(* ̄▽ ̄*)/",
    "code": 1,
    "info": {
        "msg": "这是你带来的参数, 我还返回给你, 让你看看, 证明你带过来了",
        "name": "asd",
        "age": "11"
    }
}

2.4 测试请求4

2.4.1 请求地址

/test/fourth

2.4.2 请求方式

post

2.4.3 携带参数

application/x-www-form-urlencoded 格式传递

参数名称是否必填数据类型默认值参数介绍
name必填string--
age必填number--

2.4.4 响应数据

json 格式数据

{
    "message": "我接收到了你的请求, 你的请求方式是 POST, 并且正确携带了 'name' 和 'age' 参数给我 ! <(* ̄▽ ̄*)/",
    "code": 1,
    "info": {
        "msg": "这是你带来的参数, 我还返回给你, 让你看看, 证明你带过来了",
        "name": "133",
        "age": "22"
    }
}

三、 商品相关

3.1 获取商品列表

3.1.1 请求地址

/goods/list

3.1.2 请求方式

get

3.1.3 携带参数

参数名称是否必填数据类型默认值参数介绍
current选填number1当前页
pagesize选填number12一页多少条数据
search选填string-模糊搜索关键字
filter选填hot,sale-(热销/折扣)筛选
saleType选填number(5 ~ 10)10折扣类型
sortType选填idsalepriceid排序类型
sortMethod选填ASCDESCASCASC 正序, DESC 倒序
category选填string-分类筛选条件

3.1.4 响应数据

根据你的参数给出的商品列表

{
    "message": "获取商品列表成功",
    "code": 1,
    "yourParams": {
        "msg": "这里是你传递过来的参数, 带给你看看 ^_^ ",
        ...
    },
    "list": [ ... ]
}

3.2 获取商品详细信息

3.2.1 请求地址

localhost:8888/goods/item

3.2.2 请求方式

get

3.2.3 携带参数

支持 restful 风格 localhost:8888/goods/item/:id

参数名称是否必填数据类型默认值参数介绍
id必填number-商品 id

3.2.4 响应数据

如果该商品存在, 即为该商品的详细信息

{
    "message": "获取商品详细信息成功",
    "code": 1,
    "yourParams": {
        "msg": "这里是你传递过来的参数, 带给你看看 ^_^ ",
        "id": "1"
    },
    "info": {
        ...
    }
}

3.3 获取分类列表

3.3.1 请求地址

/goods/category

3.3.2 请求方式

get

3.3.3 携带参数

3.3.4 相应数据

所有商品分类内容

{
    "message": "获取分类列表成功",
    "code": 1,
    "list": [ ... ]
}

\