bmy/ClassContent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1a0d461f03ad532883ed057456396c68219f2f50
ClassContent/项目合集/校园失物招领/min-backend/doc/api_data.js
编码猿 852d94fbb9 first commit
2024-09-27 02:06:13 +08:00

914 lines
25 KiB
JavaScript
Executable File
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

define({ "api": [
{
"type": "post",
"url": "/home/activity",
"title": "activity",
"description": "<p>获取首页轮播下活动分类商品的接口</p>",
"name": "activity",
"group": "Home",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "id",
"description": "<p>活动的id，取值对应为：1-&gt;限时白嫖，2-&gt;新品推荐，3-&gt;低价高配，4-&gt;超值特卖</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/home/activity"
}
],
"version": "1.0.0",
"filename": "routes/index.js",
"groupTitle": "Home"
},
{
"type": "post",
"url": "/home/banner",
"title": "banner",
"description": "<p>获取首页的banner数据</p>",
"name": "banner",
"group": "Home",
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/home/banner"
}
],
"version": "1.0.0",
"filename": "routes/index.js",
"groupTitle": "Home"
},
{
"type": "post",
"url": "/home/index",
"title": "index",
"description": "<p>获取首页商品列表，默认返回20条数据（不需要参数，传空对象 {} 即可 ）</p>",
"name": "index",
"group": "Home",
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/home/index"
}
],
"version": "1.0.0",
"filename": "routes/index.js",
"groupTitle": "Home"
},
{
"type": "post",
"url": "/home/info",
"title": "info",
"description": "<p>获取商品的详情接口</p>",
"name": "info",
"group": "Home",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "id",
"description": "<p>商品的id参数，从 /home/index 接口中获得 wares_id 作为id参数传入即可</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/home/info"
}
],
"version": "1.0.0",
"filename": "routes/index.js",
"groupTitle": "Home"
},
{
"type": "post",
"url": "/home/recommend",
"title": "recommend",
"description": "<p>获取首页推荐分类的数据</p>",
"name": "recommend",
"group": "Home",
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/home/recommend"
}
],
"version": "1.0.0",
"filename": "routes/index.js",
"groupTitle": "Home"
},
{
"type": "post",
"url": "/home/search",
"title": "search",
"description": "<p>搜索接口，用于首页搜索商品</p>",
"name": "search",
"group": "Home",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "keyword",
"description": "<p>搜索关键词，例如：小米</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/home/search"
}
],
"version": "1.0.0",
"filename": "routes/index.js",
"groupTitle": "Home"
},
{
"type": "post",
"url": "/car/addCar",
"title": "addCar",
"description": "<p>详情页添加商品到购物车</p>",
"name": "addCar",
"group": "car",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "waresid",
"description": "<p>需要被收藏的商品id，wares_id字段</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"成功添加购物车\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"不要重复收藏\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/car/addCar"
}
],
"version": "1.0.0",
"filename": "routes/car.js",
"groupTitle": "car"
},
{
"type": "post",
"url": "/car/checkCar",
"title": "checkCar",
"description": "<p>检查商品是否已经被用户添加到购物车，已添加 result 为true，未添加 result 为false</p>",
"name": "checkCar",
"group": "car",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "waresid",
"description": "<p>商品id，wares_id字段</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"商品已添加购物车\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 200,\n \"message\" : \"商品未添加购物车\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/car/checkCar"
}
],
"version": "1.0.0",
"filename": "routes/car.js",
"groupTitle": "car"
},
{
"type": "post",
"url": "/car/deleteCar",
"title": "deleteCar",
"description": "<p>删除被添加到购物车的商品</p>",
"name": "deleteCar",
"group": "car",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Array",
"optional": false,
"field": "carid",
"description": "<p>购物车商品id，从getCarList接口中获得car_id即可。参数格式：&quot;[1,2,3]&quot;</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"删除成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 200,\n \"message\" : \"删除失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/car/deleteCar"
}
],
"version": "1.0.0",
"filename": "routes/car.js",
"groupTitle": "car"
},
{
"type": "post",
"url": "/car/getCarList",
"title": "getCarList",
"description": "<p>获取用户的购物车商品数据（不需要参数，传空对象 {} 即可 ）</p>",
"name": "getCarList",
"group": "car",
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"购物车没有数据\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/car/getCarList"
}
],
"version": "1.0.0",
"filename": "routes/car.js",
"groupTitle": "car"
},
{
"type": "post",
"url": "/car/submitCar",
"title": "submitCar",
"description": "<p>更新购物车需要购买的商品数量，提交的数据是个对象，例如：&quot;{&quot;carList&quot;:[{&quot;waresid&quot;:113,&quot;goodsnum&quot;:2,&quot;goodsprice&quot;:1000},{&quot;waresid&quot;:114,&quot;goodsnum&quot;:1,&quot;goodsprice&quot;:1100}]}&quot;</p>",
"name": "submitCar",
"group": "car",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Object",
"optional": false,
"field": "carList",
"description": "<p>为对象，包含下面三个参数，需要前端自己构造数组</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "waresid",
"description": "<p>商品的waresid</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "goodsnum",
"description": "<p>购买的数量</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "goodsprice",
"description": "<p>购买的单价</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"订单增加成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 200,\n \"message\" : \"订单增加失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/car/submitCar"
}
],
"version": "1.0.0",
"filename": "routes/car.js",
"groupTitle": "car"
},
{
"type": "post",
"url": "/car/updateCarNum",
"title": "updateCarNum",
"description": "<p>更新购物车需要购买的商品数量</p>",
"name": "updateCarNum",
"group": "car",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "carid",
"description": "<p>购物车商品id，从getCarList接口中获得car_id即可</p>"
},
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "quantity",
"description": "<p>购物车商品的数量</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"更新成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 200,\n \"message\" : \"更新失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/car/updateCarNum"
}
],
"version": "1.0.0",
"filename": "routes/car.js",
"groupTitle": "car"
},
{
"type": "post",
"url": "/order/allOrder",
"title": "allOrder",
"description": "<p>获取不同状态的订单</p>",
"name": "allOrder",
"group": "order",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "status",
"description": "<p>查询的订单状态，0：待付款，1：待发货，2：待收货，3：退款/售后，-1：查看所有订单</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/order/allOrder"
}
],
"version": "1.0.0",
"filename": "routes/order.js",
"groupTitle": "order"
},
{
"type": "post",
"url": "/order/buyOrder",
"title": "buyOrder",
"description": "<p>submitCar提交订单后，订单页面购买支付后需要用的接口，更改订单状态为待发货</p>",
"name": "buyOrder",
"group": "order",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Array",
"optional": false,
"field": "goodsid",
"description": "<p>订单的goods_id，从allOrder接口中获得。参数格式：&quot;[5,6]&quot;</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"购买成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"购买失败，余额不足\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/order/buyOrder"
}
],
"version": "1.0.0",
"filename": "routes/order.js",
"groupTitle": "order"
},
{
"type": "post",
"url": "/type/list",
"title": "list",
"description": "<p>分类页面获取分类商品的接口</p>",
"name": "list",
"group": "type",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "typename",
"description": "<p>分类的中文名称，例如：小米</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/type/list"
}
],
"version": "1.0.0",
"filename": "routes/type.js",
"groupTitle": "type"
},
{
"type": "post",
"url": "/user/add",
"title": "add",
"description": "<p>用户注册的接口</p>",
"name": "add",
"group": "user",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "name",
"description": "<p>用户名</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "pwd",
"description": "<p>用户密码</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "phone",
"description": "<p>用户手机号</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"注册成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"注册失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/user/add"
}
],
"version": "1.0.0",
"filename": "routes/users.js",
"groupTitle": "user"
},
{
"type": "post",
"url": "/user/getUserAddress",
"title": "getUserAddress",
"description": "<p>获取用户的收货地址（不需要参数，传空对象 {} 即可 ）</p>",
"name": "getUserAddress",
"group": "user",
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 200,\n \"message\" : \"没有收货地址\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/user/getUserAddress"
}
],
"version": "1.0.0",
"filename": "routes/users.js",
"groupTitle": "user"
},
{
"type": "post",
"url": "/user/like",
"title": "like",
"description": "<p>用户在详情页收藏商品使用的接口</p>",
"name": "like",
"group": "user",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "shopid",
"description": "<p>需要被收藏商品的id，这里是商品的 wares_id 字段</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"收藏成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"抱歉，请勿重复收藏\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/user/like"
}
],
"version": "1.0.0",
"filename": "routes/users.js",
"groupTitle": "user"
},
{
"type": "post",
"url": "/user/likeList",
"title": "likeList",
"description": "<p>获取用户收藏的商品（不需要参数，后端会解密请求头token获取user_id）</p>",
"name": "likeList",
"group": "user",
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求失败\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/user/likeList"
}
],
"version": "1.0.0",
"filename": "routes/users.js",
"groupTitle": "user"
},
{
"type": "post",
"url": "/user/login",
"title": "login",
"description": "<p>用户登录的接口，注意用户登录成功后会在result中包含token参数，请前端本地保存token。</p>",
"name": "login",
"group": "user",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "name",
"description": "<p>用户名</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "pwd",
"description": "<p>用户密码</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "请求成功的返回:",
"content": "{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "请求失败的返回",
"content": "{\n \"status\": 404,\n \"message\" : \"请求错误\"\n \"result\": null\n}",
"type": "json"
}
]
},
"sampleRequest": [
{
"url": "http://127.0.0.1:9090/user/login"
}
],
"version": "1.0.0",
"filename": "routes/users.js",
"groupTitle": "user"
}
] });
Reference in New Issue View Git Blame Copy Permalink