电商 api 接口文档

Tinalee-电商API接口呀2023-10-16 11:16

1、开篇

欢迎使用ShowDoc！

API格式：

备注：API必须返回如下3个字段：

参数名 必选 类型 说明
status 是 int 状态
message 是 string 信息提示
result 否 mix 结果

2、用户相关

2.1、登录/退出

简要描述：

请求URL：

  • http://xx.com/api/login

请求方式：

  • POST

参数：

参数名 必选 类型 说明
phone_number 是 int 手机号码
code 是 int 验证码
type 类型 tinyint 1 ：7天 2：30天，默认传递2

返回示例

复制代码 
{
status: 1,
message: "OK",
result: [ ]
}

返回参数说明

简要描述：

  • 用户退出登录接口

请求URL：

  • http://xx.com/api/logout

请求方式：

  • POST GET

  • 备注

  • 更多返回错误代码请看首页的错误代码描述

    备注

  • 更多返回错误代码请看首页的错误代码描述

2.2、发送验证码

简要描述：

  • 获取短信验证码API

请求URL：

  • http://xx.com/api/smscode

请求方式：

  • POST

参数：

参数名 必选 类型 说明
phone_number 是 int 手机号码

返回示例

复制代码 
  {
    "status": 1,
   "message":"发送成功",
   "result":123
  }

返回参数说明

参数名 类型 说明
status int 状态：1成功， 0失败， -1不能重新发送
message string 消息提示

备注

  • 更多返回错误代码请看首页的错误代码描述

欢迎使用ShowDoc！

2.3、个人中心

简要描述：

  • 用户个人中心数据

请求URL：

  • http://xx.com/api/user

请求方式：

  • GET

  • 用户个人中心数据

请求URL：

  • http://xx.com/api/user/1

请求方式：

  • PUT

参数：username:用户名 sex: 0:保密， 1男， 2女。

备注

  • 更多返回错误代码请看首页的错误代码描述

3、首页相关

3.1、获取轮播图

简要描述：

  • 获取轮播图

请求URL：

  • http://xx.com/api/index/getRotationChart

请求方式：

点击轮播图跳转到详情页 xxx/api/detail/商品ID

返回示例

备注

  • 更多返回错误代码请看首页的错误代码描述

欢迎使用ShowDoc！

3.2、获取首页栏目推荐的商品

简要描述：

  • 用户注册接口

请求URL：

  • http://xx.com/api/index/cagegoryGoodsRecommend

请求方式： -GET

返回示例

1、开篇

欢迎使用ShowDoc！

API格式：

备注：API必须返回如下3个字段：

参数名 必选 类型 说明
status 是 int 状态
message 是 string 信息提示
result 否 mix 结果

2、用户相关

2.1、登录/退出

简要描述：

  • 用户登录API

请求URL：

  • http://xx.com/api/login

请求方式：

  • POST

参数：

参数名 必选 类型 说明
phone_number 是 int 手机号码
code 是 int 验证码
type 类型 tinyint 1 ：7天 2：30天，默认传递2

返回示例

复制代码 
{
status: 1,
message: "OK",
result: [ ]
}

返回参数说明

简要描述：

  • 用户退出登录接口

请求URL：

  • http://xx.com/api/logout

请求方式：

  • POST GET

  • 备注

  • 更多返回错误代码请看首页的错误代码描述

    备注

  • 更多返回错误代码请看首页的错误代码描述

2.2、发送验证码

简要描述：

  • 获取短信验证码API

请求URL：

  • http://xx.com/api/smscode

请求方式：

  • POST

参数：

参数名 必选 类型 说明
phone_number 是 int 手机号码

返回示例

复制代码 
  {
    "status": 1,
   "message":"发送成功",
   "result":123
  }

返回参数说明

参数名 类型 说明
status int 状态：1成功， 0失败， -1不能重新发送
message string 消息提示

备注

  • 更多返回错误代码请看首页的错误代码描述

欢迎使用ShowDoc！

2.3、个人中心

简要描述：

  • 用户个人中心数据

请求URL：

  • http://xx.com/api/user

请求方式：

  • GET

  • 用户个人中心数据

请求URL：

  • http://xx.com/api/user/1

请求方式：

  • PUT

参数：username:用户名 sex: 0:保密， 1男， 2女。

备注

  • 更多返回错误代码请看首页的错误代码描述

3、首页相关

3.1、获取轮播图

简要描述：

  • 获取轮播图

请求URL：

  • http://xx.com/api/index/getRotationChart

请求方式：

点击轮播图跳转到详情页 xxx/api/detail/商品ID

返回示例

备注

  • 更多返回错误代码请看首页的错误代码描述

欢迎使用ShowDoc！

3.2、获取首页栏目推荐的商品

简要描述：

  • 用户注册接口

请求URL：

  • http://xx.com/api/index/cagegoryGoodsRecommend

请求方式： -GET

返回示例

复制代码 
  {
status: 1,
message: "ok",
result: [
{
categorys: {
category_id: 1,
name: "女装",
icon: "",
list: [
{
name: "牛仔裤",
category_id: 2
},
{
name: "短裤",
category_id: 2
},
{
name: "休闲裤",
category_id: 2
},
{
name: "打底裤",
category_id: 2
},
{
name: "丝袜",
category_id: 2
}
]
},
goods: [
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 12.13,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 2,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 123.13,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 1256.1,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 4569,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 89.9,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 320.1,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 12.13,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "8原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 458,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "9原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 123,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "10原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 345,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
}
]
},
{

  {
status: 1,
message: "ok",
result: [
{
categorys: {
category_id: 1,
name: "女装",
icon: "",
list: [
{
name: "牛仔裤",
category_id: 2
},
{
name: "短裤",
category_id: 2
},
{
name: "休闲裤",
category_id: 2
},
{
name: "打底裤",
category_id: 2
},
{
name: "丝袜",
category_id: 2
}
]
},
goods: [
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 12.13,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 2,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 123.13,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 1256.1,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 4569,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 89.9,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 320.1,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 12.13,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "8原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 458,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "9原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 123,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
},
{
id: 1,
title: "10原创设计日常汉服女款绣花长褙子吊带改良宋裤春夏",
price: 345,
image: "http://testmall.singwa666.com/static/upload/image/10.jpg"
}
]
},
{
相关推荐
wefg18 分钟前
【Redis】C++ 自定义客户端
数据库·redis·缓存
Chrischaan14 分钟前
做 AI 塔罗小程序时，我为什么不让大模型自己抽牌：一次上线复盘
前端
这个DBA有点耶18 分钟前
为什么UPDATE比SELECT危险得多？锁范围等于扫描行数
数据库·架构·代码规范
天国梦43 分钟前
国密门禁品牌怎么选？2026年最新3个避坑要点
运维·服务器·数据库·python
骑着蜗牛撵大象32744 分钟前
LangChain 工具调用从声明到闭环：给智能体接上真实的手脚
前端
DB哥讲数据库1 小时前
【达梦数据库安装教程】超详细图文讲解-附达梦安装包
数据库·oracle
数据掘金1 小时前
百度统计后台页面数据异常？从手动调用时机开始排查
前端
hunteritself1 小时前
10 层 4K 实时剪辑，国产工作站进入广电制作核心
大数据·前端·人工智能·深度学习·transformer
踩着两条虫1 小时前
我在浏览器里“盖”了一个村：Vue + Three.js 大屏开发踩坑记
前端·vue.js·three.js
mbshqqb1 小时前
TypeScript基础教程之同步生成器
前端·javascript·typescript
热门推荐
01国内可直接用、免费额度/永久免费的大模型API清单（含 SiliconFlow、火山、阿里、智谱、百度、Kimi、DeepSeek、DMXAPI 等）02历年考研数学一、数学二、数学三真题试卷及答案PDF03如何新建文件夹？ 电脑新建文件夹的4种方法04「全语录+省流版」邵艾伦 × 孙宇晨：聊风口、聊个人IP、聊年轻人如何抓住 AI 时代的机会05GitHub 镜像站点06蜘蛛磁力 搜索引擎大全，如何使用蜘蛛磁力查找磁力链接07轻量化AI渗透武器库｜ARTEX自主攻防系统、资产梳理、漏洞挖掘、链路分析全流程智能化落地08Windows 10/11 如何退出微软账户并改用本地账户登录（含找不到选项的解决方法）09Telegram APK 下载安装完整指南 — 2026年最新10微信历史版本含下载地址（ Windows PC | 安卓 | MAC ）及设置微信不更新