电商 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"
}
]
},
{
相关推荐
思麟呀6 分钟前
应用层自定义协议与序列化
linux·运维·服务器·网络·c++
吴所畏惧6 分钟前
前端打包cdn或者dll打包方式
前端
小鲤鱼ya9 分钟前
vue3 + ts + uni-app 移动端封装图片上传添加水印
前端·typescript·uni-app·vue3
6+h10 分钟前
【Redis】数据结构讲解
数据结构·数据库·redis
霍理迪11 分钟前
Vue—条件渲染与循环渲染
前端·javascript·vue.js
ID_1800790547312 分钟前
小红书笔记详情 API 接口系列 + 标准 JSON 返回参考（完整版）
数据库·笔记·json
wertyuytrewm14 分钟前
用Python实现自动化的Web测试（Selenium）
jvm·数据库·python
Lost_in_the_woods15 分钟前
Java程序员的Linux之路——命令篇
linux·运维·服务器
xixixin_15 分钟前
【CSS】字体大小不一致？px与vw渲染差异的底层原理与解决方案
前端·css
IpdataCloud16 分钟前
在线IP查询API与本地离线库，速度与安全如何选型？
运维·服务器·网络
热门推荐
01GitHub 镜像站点02Qwen3.5 开源全解析：从 0.8B 到 397B，代际升级 + 全场景选型指南03OpenClaw 使用和管理 MCP 完全指南04Labelme从安装到标注：零基础完整指南05AI 编程三剑客：Spec-Kit、OpenSpec、Superpowers 深度对比与实战指南06UV安装并设置国内源07小黑课堂计算机二级WPSoffice题库软件下载安装教程（2026年3月最新版）08OpenClaw Control UI安全上下文访问配置09Claude Code + GLM4.7 避坑指南：解决 Unable to connect to Anthropic services10“wsl --install -d Ubuntu-22.04”下载慢，中国地区离线安装 Ubuntu 22.04 WSL方法（亲测2025年5月6日）