# api_server **Repository Path**: kula0410/api_server ## Basic Information - **Project Name**: api_server - **Description**: 基于node的一个二手购物市场的后台服务器 - **Primary Language**: NodeJS - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 3 - **Forks**: 0 - **Created**: 2021-03-04 - **Last Updated**: 2022-11-15 ## Categories & Tags **Categories**: Uncategorized **Tags**: Nodejs, Express ## README # 二手市场后端API服务器接口文档 + 分为客户端服务和后台管理端两套API服务 + 服务器已开启`Gzip`服务和`Cors`跨域处理 + 支持`token`认证、文件上传 + 数据库使用 `MongoDB `作为后台数据库 + 需要授权的 API ，必须在请求头中使用 `Authorization` 字段提供 `token` 令牌 + 使用 HTTP Status Code 标识状态 + 数据返回格式统一使用 `JSON` ## 1. API 基址 + 客户端服务 ~~~ // 测试基址 http://localhost:5000/api/public/v1 // 线上https基址（参考） https://www.yycloud.ltd/api/public/v1 ~~~ + 后台管理服务 ~~~ // 测试基址 http://localhost:5000/api/private/v1 // 线上https基址（参考） https://www.yycloud.ltd/api/private/v1 ~~~ ## 2. 支持的请求方法 - GET：从服务器数据。 - POST：获取敏感数据、或进行敏感操作。 ## 3. 状态码说明 | *状态码* | *含义* | *说明* | | -------- | --------------------- | --------------------------------------------------- | | 200 | OK | 请求成功 | | 201 | CREATED | 创建成功 | | 204 | DELETED | 删除成功 | | 400 | BAD REQUEST | 请求的地址不存在或者包含不支持的参数 | | 401 | UNAUTHORIZED | 未授权 | | 403 | FORBIDDEN | 被禁止访问 | | 404 | NOT FOUND | 请求的资源不存在 | | 422 | Unprocesable Entity | [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误 | | 500 | INTERNAL SERVER ERROR | 服务器内部错误 | ## 3. API 路由表 #### 3.1 后台管理端 ('/api/private/v1') | 请求方法 | 路径 | 参数 | 参数说明 | 备注 | | -------- | ------------------- | --------------------------------- | ---------------------------- | ---------------------------------- | | POST | /admin/login | username, password | 用户名、密码 | 管理员登陆 | | GET | /admin/detail | username | 用户名 | 获取管理员信 | | GET | /admin/list | query, pagenum, pagesize | 查询关键字、页码、页容量 | 获取全部管理员列表信息 | | POST | /admin/add | username, password,role,status... | 用户名、密码、角色、权限分配 | 添加新的管理员 | | POST | /admin/delete | username | 用户名 | 删除指定管理员 | | POST | /admin/update | ... | ... | 更新管理员信息 | | GET | /goods/audit | | | 获取商品审核列表 | | POST | /goods/audit | goods_id, flag | 商品编号、审核状态码 | 审核商品 | | GET | /goods/list | query, pagenum, pagesize | 查询关键字、页码、页容量 | 获取所有商品列表 | | GET | /goods/detail | goods_id | 商品编号 | 获取指定商品详细信息 | | POST | /goods/update | ... | ... | 更新指定商品信息 | | POST | /goods/delete | goods_id | 商品编号 | 删除指定商品 | | POST | /goods/state | goods_id, status | 商品编号、状态值 | 更改指定商品状态 | | GET | /home/swiper | | | 获取轮播图数据 | | POST | /home/swiper/update | ... | ... | 更新轮播图数据 | | POST | /home/swiper/delete | index | 轮播项编号 | 删除指定轮播项 | | POST | /home/swiper/add | ... | ... | 添加新的轮播项 | | GET | /home/uploadHomr | | | 获取图床页面 | | POST | /home/upload | ... | ... | 图片上传 | | GET | /order/list | query, pagenum, pagesize | 查询关键字、页码、页容量 | 获取全部订单列表 | | GET | /order/address | | | 获取全国地址五级联动数据（已废弃） | | POST | /order/update | ... | ... | 更新订单数据 | | POST | /order/delete | order_id | 订单编号 | 删除订单 | | POST | /order/state | order_id, status | 订单编号, 订单状态值 | 更改订单状态值 | | GET | /sorts/list | | | 获取分类标题数组 | | GET | /sorts/sortlist | | | 获取分类信息列表 | | POST | /sorts/update | ... | ... | 更新分类项信息 | | POST | /sorts/add | ... | ... | 添加新的分类项 | | POST | /sorts/delete | _id | 分类编号（数据库主键码） | 删除指定分类项 | | GET | /users | query, pagenum, pagesize | 查询关键字、页码、页容量 | 获取所有用户列表 | | POST | /users/userInfo | openid | 用户编号 | 获取指定用户详细信息 | | POST | /users/editUser | .. | ... | 更改指定用户信息 | | POST | /users/delete | openid | 用户编号 | 删除指定用户 | | POST | /users/state | openid, status | 用户编号、状态码 | 更改用户状态 | #### 3.2 客户端 ('/api/public/v1') | 请求方法 | 路径 | 参数 | 参数说明 | 备注 | | -------- | -------------------- | ----------------------------- | ------------------------ | ------------------------------ | | GET | /categories | | | 获取分类数据 | | GET | /categories/names | | | 获取全部分类名称（允许展示的） | | POST | /comment/userSession | recipient_id, sender_id | 接收者编号、发送者编号 | 获取单个用户一对一会话列表 | | POST | /comment/create | ... | ... | 一对一会话时，创建单个会话信息 | | POST | /comment/contacts | openid | 用户编号 | 获取和用户产生对话的联系人列表 | | GET | /goods/detail | goods_id | 商品编号 | 获取指定商品详情 | | GET | /goods/goodsList | goods_type, pageNum, pageSize | 查询关键字、页码、页容量 | 获取商品列表（允许展示的） | | GET | /goods/search | query | 查询关键字 | 查询指定商品信息 | | | | | | | ## 4. 路由详情