Skip to content

barcaYY/ShoppingMallAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

# 接口说明文档

前期准备:

1、准备开发环境<br/>

①启动mysql/Nodejs(8.1.1)<br/>

②准备写好的mySQ文件xz.sql

一、用户模块

1.1、  用户注册

接口地址:http://127.0.0.1:8080/user/register

返回格式:json

请求方式:post

请求示例:http://127.0.0.1:8080/user/register

请求参数说明:

名称

必填

类型

说明

uname

String

用户名

upwd

String

密码

email

String

邮箱

phone

string

电话

返回参数

名称

类型

说明

code

Int

返回码

200-注册成功

401-用户名为空

402-密码为空

403-邮箱为空

404-电话为空

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”register suc” }

 

1.2、  用户登录

接口地址:http://127.0.0.1:8080/user/login

返回格式:json

请求方式:post

请求示例:http://127.0.0.1:8080/user/login

请求参数说明:

名称

必填

类型

说明

uname

String

用户名

upwd

String

密码

返回参数

名称

类型

说明

code

Int

返回码

200-注册成功

301-用户名或密码错误

401-用户名为空

402-密码为空

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”login suc” }

 

1.3、  用户检索

接口地址:http://127.0.0.1:8080/user/detail

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/user/detail?uid=1

请求参数说明:

名称

必填

类型

说明

Uid

Int

用户编号

返回参数

名称

类型

说明

code

Int

返回码

301-未检索到用户

401-用户名为空

msg

string

返回说明

返回示例

{http://tool.oschina.net/tools/json_format/Expanded.gif

    "uid": 1,

    "uname": "dingding",

    "upwd": "123456",

    "email": "[email protected]",

    "phone": "13501234567",

    "avatar": "img/avatar/default.png",

    "user_name": "丁伟",

    "gender": 1

}

 

1.4、  删除用户

接口地址:http://127.0.0.1:8080/user/delete

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/user/delete?uid=1

请求参数说明:

名称

必填

类型

说明

Uid

Int

用户编号

返回参数

名称

类型

说明

code

Int

返回码

200-成功删除

301-删除失败

401-用户编号为空

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”delete suc” }

 

1.5、  修改用户信息

接口地址:http://127.0.0.1:8080/user/update

返回格式:json

请求方式:post

请求示例:http://127.0.0.1:8080/user/update

请求参数说明:

名称

必填

类型

说明

ui

int

用户编号

email

String

邮箱

phone

string

电话

gender

Int

性别

1- 0-

user_name

String

真实姓名

返回参数

名称

类型

说明

code

Int

返回码

200-注册成功

301-更改失败

401-用户编号为空

402-邮箱为空

403-电话为空

404-性别为空

406-真姓实名为空

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”update suc” }

 

1.6、  用户列表

接口地址:http://127.0.0.1:8080/user/list

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/list/detail?pno=1&pageSize=10

请求参数说明:

名称

必填

类型

说明

pno

Int

页码

pageSize

Int

每页大小

返回参数——数组

Json返回示例

{

    "recordCount": 4,

    "pageSize": 9,

    "pageCount": 1,

    "pno": 1,

    "data": [

        {

            "uid": 4,

            "uname": "yaya",

            "email": "[email protected]",

            "phone": "13501234560",

            "avatar": "img/avatar/default.png",

            "user_name": "秦小雅",

            "gender": 0

        },

        {

            "uid": 3,

            "uname": "doudou",

            "email": "[email protected]",

            "phone": "13501234569",

            "avatar": "img/avatar/default.png",

            "user_name": "窦志强",

            "gender": 1

        }

    ]

}

 

1.7、  检测邮箱

接口地址:http://127.0.0.1:8080/user/checkemail

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/user/[email protected]

请求参数说明:

名称

必填

类型

说明

email

string

用户邮箱

返回参数

名称

类型

说明

code

Int

返回码

200-不存在

201-已存在

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”non-exists” }

 

1.8、  检测手机

接口地址:http://127.0.0.1:8080/user/checkphone

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/user/checkphone?phone=18111111111

请求参数说明:

名称

必填

类型

说明

phone

string

用户电话

返回参数

名称

类型

说明

code

Int

返回码

200-不存在

201-已存在

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”non-exists” }

 

1.9、  检测用户名

接口地址:http://127.0.0.1:8080/user/checkuname

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/user/checkuname?uname=jing

请求参数说明:

名称

必填

类型

说明

uname

string

用户邮箱

返回参数

名称

类型

说明

code

Int

返回码

200-不存在

201-已存在

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”non-exists” }

 

1.10、       退出登录

接口地址:http://127.0.0.1:8080/user/logout

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/user/logout

 

Json返回示例

{ “code”:”200”, “msg”:”logout succ” }

 

1.11、       获取当前用户信息

接口地址:http://127.0.0.1:8080/user/sessiondata

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/user/sessiondata

 

Json返回示例

{ “uid”:”1”, “uname”:”dingding” }

 

二、用户模块

1.1、  商品列表

接口地址:http://127.0.0.1:8080/product/list

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/product/list?pno=1&pageSize=10

请求参数说明:

名称

必填

类型

说明

pno

Int

页码

count

Int

每页大小

返回参数——数组

Json返回示例

{

    "recordCount": 43,

    "pageSize": 5,

    "pageCount": 9,

    "pno": 2,

    "data": [

        {

            "lid": 29,

            "title": "联想(ThinkPad)轻薄系列E470c(20H3A004CD)14英寸笔记本电脑(i5-6200U 8G 500G 2G独显 Win10)黑色",

            "price": 4699,

            "sold_count": 1862,

            "is_onsale": 0,

            "pic": "img/product/md/584b5678Nbc9f1e70.jpg"

        },

        {

            "lid": 43,

            "title": "神舟(HASEE)战神Z6-KP7GT 15.6英寸游戏本笔记本电脑(i7-7700HQ 8G 1T+128G SSD GTX1050 1080P)黑色",

            "price": 5699,

            "sold_count": 1844,

            "is_onsale": 1,

            "pic": "img/product/md/58a2c667Ne2b5cb73.jpg"

        }

    ]

}

 

1.2、  商品详情

接口地址:http://127.0.0.1:8080/product/detail

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/product/detail?lid=1

请求参数说明:

名称

必填

类型

说明

lid

Int

商品编号

Json返回示例

{http://tool.oschina.net/tools/json_format/Expanded.gif

    "details": {http://tool.oschina.net/tools/json_format/Expanded.gif

        "lid": 2,

        "family_id": 1,

        "title": "Apple MacBook Air 13.3英寸笔记本 银色(Core i5 处理器/8GB内存/256GB SSD闪存 MMGG2CH/A)",

        "subtitle": "5月焕新季,领券买新机!神券满8000800!一体成型金属机身,纤薄轻巧,长达12小时续航",

        "price": 8268,

        "promise": "*退货补运费 *30天无忧退货 *48小时快速退款 *72小时发货",

        "spec": "双核i5/8GB内存/256GB闪存",

        "lname": "AppleMacBook Air",

        "os": "MacOS",

        "memory": "8G",

        "resolution": "1920*1080",

        "video_card": "集成显卡",

        "cpu": "Intel i5低功耗版",

        "video_memory": "其它",

        "category": "轻薄本",

        "disk": "256G固态",

        "details": "<div class=\"content_tpl\"> <div class=\"formwork\">   <div class=\"formwork_img\"><br></div><div class=\"formwork_img\">    <img alt=\"\" class=\"\" src=\"img/product/detail/57b15612N81dc489d.jpg\">   </div>  </div>  <div class=\"formwork\">   <div class=\"formwork_img\">    <img alt=\"\" class=\"\" src=\"//img20.360buyimg.com/vc/jfs/t2683/60/4222930118/169462/233c7678/57b15616N1e285f09.jpg\">   </div>  </div>  <div class=\"formwork\">   <div class=\"formwork_text\">    技术规格请前往 www.apple.com/cn/macbook-air/specs.html 查看完整内容。</div></div></div>",

        "shelf_time": 150223456789,

        "sold_count": 1922,

        "is_onsale": 0,

        "picList": [

            {

                "pid": 4,

                "laptop_id": 2,

                "sm": "img/product/sm/57b12a31N8f4f75a3.jpg",

                "md": "img/product/md/57b12a31N8f4f75a3.jpg",

                "lg": "img/product/lg/57b12a31N8f4f75a3.jpg"

            },

            {

                "pid": 5,

                "laptop_id": 2,

                "sm": "img/product/sm/57ad359dNd4a6f130.jpg",

                "md": "img/product/md/57ad359dNd4a6f130.jpg",

                "lg": "img/product/lg/57ad359dNd4a6f130.jpg"

            },

            {

                "pid": 6,

                "laptop_id": 2,

                "sm": "img/product/sm/57ad8846N64ac3c79.jpg",

                "md": "img/product/md/57ad8846N64ac3c79.jpg",

                "lg": "img/product/lg/57ad8846N64ac3c79.jpg"

            }

        ]

    },

    "family": {

        "fid": 1,

        "fname": "AppleMacBookAir",

        "laptopList": [

            {

                "lid": 1,

                "spec": "双核i5/8GB内存/128GB闪存"

            },

            {

                "lid": 2,

                "spec": "双核i5/8GB内存/256GB闪存"

            },

            {

                "lid": 3,

                "spec": "定制款:双核i7/8G内存/128G闪存"

            },

            {

                "lid": 4,

                "spec": "定制款:双核i7/8G内存/256G闪存"

            }

        ]

    }

}

 

1.3、删除商品

接口地址:http://127.0.0.1:8080/product/delete

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/product/delete?lid=1

请求参数说明:

名称

必填

类型

说明

lid

Int

商品编号

返回参数

名称

类型

说明

code

Int

返回码

200-成功删除

301-删除失败

401-商品编号为空

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”delete suc” }

 

1.4、商品添加

作用:添加商品

返回格式:json

请求方式:post

请求示例:http://127.0.0.1:8080/product/add

请求参数说明:

名称

必填

类型

说明

family_id

int

#所属型号家族编号

title

String

#主标题

subtitle

String

#副标题

price

float

#价格

promise

String

#服务承诺

spec

string

#规格/颜色

lname

string

#商品名称

os

string

#操作系统

memory

string

#内存容量

resollution

string

#分辨率

video_card

string

#显卡型号

cpu

string

#处理器

video_memory

string

#显存容量

category

string

#所属分类

disk

string

#硬盘容量及类型

details

string

#产品详细说明

shelf_time

int

#上架时间

sold_count

int

#已售出的数量

is_onsale

int

#是否在售

返回参数

名称

类型

说明

code

Int

返回码

200-添加成功

401-所属家族编号为空

402-标题为空

403-二级为空

404-价格为空

...

msg

string

返回说明

Json返回示例

{ “code”:”200”, “msg”:”add suc” }

 

三、购物车模块

1.1、添加购物车

接口地址:http://127.0.0.1:8080/cart/add

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/cart/add?lid=1&buyCount=5

请求参数说明:

名称

必填

类型

说明

lid

Int

商品编号

buyCount

int

购买数量

json返回实例

{ “code”:”200”, “msg”:”add suc” }

 

1.2、购物车列表

接口地址:http://127.0.0.1:8080/cart/list

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/cart/list

 

json返回实例

{http://tool.oschina.net/tools/json_format/Expanded.gif

    "code": 200,

    "data": [http://tool.oschina.net/tools/json_format/Expanded.gif

        {http://tool.oschina.net/tools/json_format/Expanded.gif

            "iid": "987",

            "lid": "17",

            "title": "联想(Lenovo)小新700电竞版 15.6英寸游戏笔记本电脑(i5-6300HQ 8G 500G+128G SSD GTX950M 4G IPS)",

            "spec": "小新700i5 双硬盘 GTX950M",

            "price": "5199.00",

            "count": "1",

            "pic": "img/product/sm/587f476aNcfbf7869.jpg"

        }

    ]

}

 

1.3、删除购物车

接口地址:http://127.0.0.1:8080/cart/del

返回格式:json

请求方式:get

请求示例:http://127.0.0.1:8080/cart/del?iid=2

请求参数说明:

名称

必填

类型

About

A project about ShoppingMallAPI based Node.js/mySQL

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors