markdown文档编写

- [Model说明](#model)
- [public公共模型](#publicmodel)
         - [categorydo](#categorydo)
         - [spudto](#spudto)
         - [skudto](#skudto)
         - [listdto](#listdto)
         - [optiondto](#optiondto)
         - [productdto](#productdto)
         - [cartdo](#cartdo)
         - [upselldo](#upselldo)
         - [user](#user)
         - [userorderdo](#userorderdo)
         - [addressdo](#addressdo)
         - [orderdo](#orderdo)
         - [shippingdo](#shippingdo)
         - [discountdo](#discountdo)
         - [commentdo](#commentdo)
         - [userdo](#userdo)
         - [commentrequest](#commentrequest)
- [接口](#接口)
     - [用户接口](#用户接口)
       - [用户注册](#用户注册)
       - [用户登录](#用户登录)  
       - [非注册用户注册](#非注册用户注册)
       - [更新密码](#更新密码)
       - [邮箱更新密码](#邮箱更新密码)
       - [找回密码](#找回密码)
       - [用户订单](#我的订单)
       - [订单详情](#订单详情)
       - [所有地址](#所有地址)
       - [修改地址](#修改地址)
       - [添加地址](#添加地址)
     - [category接口](#category)
       - [商品菜单列表](#商品菜单列表) 
       - [商品分类查询](#商品分类查询)
       - [底部列表](#底部列表)
     - [product接口](#product)
       - [搜索商品](#搜索商品) 
       - [商品详情](#商品详情)
       - [商品聚合](#商品聚合)
       
     - [购物车接口](#购物车接口)
       - [增加产品到购物车](#增加产品到购物车)
       - [增加多个产品到购物车](#增加多个产品到购物车)
       - [增加数量](#增加数量)
       - [修改数量](#修改数量)
       - [删除](#删除)
       - [购物车列表](#购物车列表)
       
- [订单接口](#订单接口)  
        - [创建订单](#创建订单)
        - [查询订单](#查询订单)
        
- [折扣接口](#折扣接口)
   - [得到spu的可用折扣](#得到spu的折扣)
   - [用户挑选一个折扣](#用户挑选一个折扣)
   - [删除折扣](#删除折扣)
   
     - [评论接口](#评论接口)
        - [所有评论](#所有评论)
        - [子评论](#子评论)
        - [删除评论](#删除评论)
        - [修改评论](#修改评论)
        - [发送评论](#发送评论)
        - [回复评论](#回复评论)
        - [赞评论](#赞评论)
        - [踩评论](#踩评论)


















## model       


### publicModel




### user


|字段|类型|说明|
|---|---|----
userId|String|用户id
userEmail|String|email
userName|String|用户名
password|String|密码
phoneNumber|String|电话
avatar|String|头像
fbAccount|String|第三方登录
gmtCreate|long|创建时间
gmtModify|long|修改时间
status|Integer|状态（3黑名单,0删除）


### shippingdo


|字段|类型|说明|
|---|---|----
addressDO|[addressdo](#addressdo)|
shippingId|long|
shippingFee|long|


### commentrequest
|字段|类型|说明|
|---|---|----
atUserId|String|
commentIndexId|String|
commentId|String|
content|String|内容
picture|String|图片
star | int|星级
skuId|String|skuId


### userorderdo


|字段|类型|说明|
|---|---|---|
orderId|string|订单id
itemName|String|名称
itemOptionName|String|型号选项
itemSkuId|String|类型|skuid
discount|String|数量
note|String|
attr|List|
quantity|int|图片
shippingFee|String|邮费
date|String|时间
status|int|状态
buyerId|String|购买者id
itemSpuId|String|spuid
itemImage|String|图片
price|String|价格
sub|List<[userorderdo](#userorderdo)>|子订单




### categorydo


|字段|类型|说明|
|---|---|---|
name|string|名称
image|String|图片
id|long|id
type|int|类型|（分类依据）
description|String|描述
categoryOrder|int|排序
sub|List<[categorydo](#categorydo)>|子分类


### listdto


|字段|类型|说明|
|---|---|---|
items|List|
pageToken|string|页








### spudto


|字段|类型|说明|
|---|---|---|
id|long|spu的id
images|List|图片列表
name|String|名称
description|String|描述
price| long|价格
comparePrice|long|相比价格
optionName|String|商品选项比如name=“颜色” value=“28寸”
attributes|List
category|List<[categorydo](#categorydo)>|对应的分类
status|String|在售 下架


### skudto


|字段|类型|说明|
|---|---|---|
id|long|id
image|String|图片
options|List|spu中的某选项
price| long |价格
comparePrice| long|原价
quantity| int|数量
attributes|List|
isbn|string|isbn
name|String|名称
spuId|String|对应的spuid
combineId|String|对应的聚合id
upSell|[upselldo](#upselldo)|折扣
canUseUpSell|[upselldo](#upselldo)|可折扣






### optiondto


|字段|类型|说明|
|---|---|---|
options|List|spu中的某选项
price|long|价格
id|String|id
image|String|图片
quantity|int|库存


### productdto
|字段|类型|说明|
|---|---|---|
spudto|[spudto](#spudto)|
skudto|[skudto](#skudto)|
options|List<[optiondto](#optiondto)>|


### userdo
用户
|字段|类型|说明|
|---|---|---|
|nearOrderDo|[userorderdo](#userorderdo)|最近订单
|nearSubUserOrderDOLit|List<[userorderdo](#userorderdo)>|最近订单子订单列表
|addressList|List<[addressdo](#addressdo)>|地址列表
|userId|String|id
|userEmail|String|email
|userName|String|用户名
|password|String|密码
|phoneNumber|String|电话
|avatar|String|头像
|fbAccount|String|第三方登录
|gmtCreate|long|开始时间
|gmtModify|long|修改的时间
|status|int|状态（3黑名单,0删除|
|RegistDays|int|注册了多久|






### cartdo


|字段|类型|说明|
|---|---|---|
userId|String|用户id
items|List<[skudto](#skudto)>|sku列表
upSell|[UpSellDO](#UpSellDO)|折扣
note|String
totalFee|long|总金额
itemsFee|long|产品金额
shippingFee|long|运费
discountFee|long|折扣金额
shipping|int|运费类型
canUseUpSell|[UpSellDO](#upselldo)|


### upselldo


|字段|类型|说明|
|---|---|---|
reason|String|折扣原因
code|String|折扣码
discountAmount|long|数量
target|String|目标人
type|int|类型








### addressdo


|字段|类型|说明|
|---|---|---|
firstName|String|姓
lastName|String|名
postalCode|String|邮编
phoneNumber|String|电话
country|String|国家
province|String|省
city|String| 城市
address|String|地址
addressId|long|地址id
defaultAdd|boolean|是否默认
userId|String|用户id
email|String|电子邮件










### orderdo


|字段|类型|说明|
|---|---|---|
cartDo|[cartdo](#cartdo)|
shippingDo|[shippingdo](#shippingdo)|
orderId|String|
payMethod|String|
useEmail|String|
sign|String|




### discountdo
|字段|类型|说明|
|---|---|---|
discountId|long|折扣id
discountCode|String|折扣码
discountType|int|类型
discountValue|long|折扣金额
ruleMinPurchase|long|规则-最小购买
ruleStartTime|long|规则-开始时间
ruleEndTime|long|规则-结束时间
ruleApplies|String|规则-允许使用的人群
ruleAmount|long|规则-总额
ruleItemCount|int|规则-数量
status|int|状态
gmtCreate|long|创建时间
gmtModify|long|更新时间
description|String|描述
name|string|名称






### commentdo
|字段|类型|说明|
|---|---|---|
skuId|long|
id|String|
indexId|String|
content|String|
createdAt|long|
likeCount|long|
user|[userdo](#userdo)|
atuser|[userdo](#userdo)|
uped|boolean|
childCount|long|评论数
pictures|List|
star|int|星级
children|[listdto](#listdto)<[commentdo](#commentdo)>|子评论


































































































































# 接口
## category
#### 商品菜单列表
**请求**


~~~
GET /api/v1/c/menu
~~~


**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data|[ListDTO](#listdto)<[CategoryDO](#categorydo)>|


#### 商品分类查询
**请求**


~~~
GET /api/v1/c/{cId}
~~~
**参数**


|字段|类型|说明|
|---|---|---|
||String|{cId}
|pageToken|String|default=0
|orderBy|String|required=false
|size|int|default=8 required=false


**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data|[ListDTO](#listdto)<[spudto](#spudto)>|










#### 底部列表
**请求**


~~~
GET /api/v1/c/footer/list
~~~


**应答**


|字段|类型|说明|
|---|---|---|
||[ListDTO](#listdto)<[categorydo](#categorydo)>|




## product
#### 搜索商品
**请求**


~~~
get /api/v1/p/search
~~~
**参数**


|字段|类型|说明|
|---|---|---|
|word|String|
|start|int|
|size|int|


**应答**


字段|类型|说明|
|---|---|---|
|status|int|
|data|[Listdto](#listdto)[|






#### 商品详情
**请求**
~~~
get /api/v1/p/{id}
~~~
**参数**


|字段|类型|说明|
|---|---|---|
||String|{id}




**应答**


字段|类型|说明|
|---|---|---|
|status|int|
|data|[productdto](#productdto)|






#### 商品聚合
**请求**


~~~
get /api/v1/p/combine/{id}
~~~
**参数**


|字段|类型|说明|
|---|---|---|
||String|{id}




**应答**


字段|类型|说明|
|---|---|---|
|status|int|
|data|List<[productdto](#productdto)>|




## 购物车接口
#### 增加产品到购物车
**请求**


~~~
post /api/v1/cart/add
~~~
**参数**


|字段|类型|说明|
|---|---|---|
|skuId|String|
|quantity|int|




**应答**


字段|类型|说明|
|---|---|---|
||[CartDO](#cartdo)|




#### 增加多个产品到购物车
**请求**


~~~
post /api/v1/cart/adds
~~~
**参数**


|字段|类型|说明|
|---|---|---|
|skuIds|String|以“,”隔开
|quantity|int|


**应答**


字段|类型|说明|
|---|---|---|
||[CartDO](#cartdo)|




#### 增加数量
**请求**


~~~
post /api/v1/cart/add/quantity
~~~
**参数**


|字段|类型|说明|
|---|---|---|
|skuIds|String|
|quantity|int|


**应答**


字段|类型|说明|
|---|---|---|
||[CartDO](#cartdo)|




#### 修改数量
**请求**


~~~
post /api/v1/cart/set/quantity
~~~
**参数**


|字段|类型|说明|
|---|---|---|
|skuIds|String|
|quantity|int|


**应答**


字段|类型|说明|
|---|---|---|
||[CartDO](#cartdo)|


#### 删除
**请求**


~~~
post /api/v1/cart/remove
~~~
**参数**


|字段|类型|说明|
|---|---|---|
|skuIds|String|


**应答**


字段|类型|说明|
|---|---|---|
||[CartDO](#cartdo)|


#### 购物车列表
**请求**


~~~
get /api/v1/cart/list
~~~


**应答**


字段|类型|说明|
|---|---|---|
|status|int|
|data|[CartDO](#cartdo)|


















## 用户接口






#### 用户登录
**请求**


~~~
post /api/v1/u/login
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|email|String|
|pwd|String|


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data||








#### 用户注册
**请求**


~~~
post /api/v1/u/register
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|email|String|
|name|String|
|pwdr|String|确认密码
|pwd|String|


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data||






#### 非注册用户注册
**请求**


~~~
post /api/v1/u/subscribe
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|email|String|




**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[user](#user)|










#### 更新密码
**请求**


~~~
post /api/v1/u/update/pwd
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|email|String|
|old|String|旧密码
|pwd|String|
|pwdr|String|确认密码
**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data||










#### 找回密码
**请求**


~~~
post /api/v1/u/find/pwd
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|email|String|
**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data||




#### 邮箱更新密码
**请求**


~~~
post /api/v1/u/reset/pwd
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|email|String|
|uid|String|用户id
|pwd|String|
|pwdr|String|确认密码
**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data||






#### 我的订单
**请求**


~~~
get /api/v1/u/my/orders
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|pageToken|String|
|size|int|页面大小
**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[listdto](#listdto)<[userorderdo](#userorderdo)>|




#### 订单详情
**请求**


~~~
get /api/v1/u/my/orders/detail/{orderId}
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|orderId|String|


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[userorderdo](#userorderdo)|








#### 所有地址
**请求**


~~~
get /api/v1/u/my/address
~~~
**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[listdto](#listdto)<[addressdo](#addressdo)>|










#### 修改地址
**请求**


~~~
post /api/v1/u/my/address/modify
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|[addressdo](#addressdo)|json|


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[addressdo](#addressdo)|






#### 添加地址
**请求**


~~~
post /api/v1/u/my/address/add
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|[addressdo](#addressdo)|json|


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[addressdo](#addressdo)|








## 订单接口
#### 创建订单
**请求**


~~~
post /api/v1/order/create
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|[orderdo](#orderdo)|json|


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[orderdo](#orderdo)|json|








#### 查询订单
**请求**


~~~
all /api/v1/order/{orderSign}/{orderId}
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{orderSign}|String|签名|
|{orderId}|String||


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[orderdo](#orderdo)|json|












## 折扣接口


#### 得到spu的可用折扣
**请求**


~~~
get /api/v1/coupon/spu/{spuid}
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{spuid}|String||
|size|int||




**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data|[listdto](#listdto)<[discountdo](#discountdo)>|json|




#### 用户挑选一个折扣
**请求**


~~~
post /api/v1/coupon/pick/{code}
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{code}|String||




**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data||






#### 删除折扣
**请求**


~~~
post /api/v1/coupon/remove/{code}
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{code}|String||


**应答**


字段|类型|说明|
|---|---|---|
|status|int|状态：1成功，0失败
|data||










## 评论接口
#### 所有评论
**请求**
~~~
GET /api/v1/comment/spu/{spuId}/comments
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|uid|String|
|page_token|String|
|count|int|
|{spuId}|String|
**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data|[ListDTO](#listdto)<[commentdo](#commentdo)>|






#### 子评论
**请求**
~~~
GET /api/v1/comment/comments/{indexId}/{uuid}/comments
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{indexId}|String|
|{uuid}|String|
|page_token|String|
**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data|[ListDTO](#listdto)<[commentdo](#commentdo)>|




#### 删除评论
**请求**
~~~
delete /api/v1/comment/comments/{commentIndexId}/{commentId}
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{commentIndexId}|String|
|{commentId}|String|
|[commentrequest](#commentrequest)|json|
**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data||




#### 修改评论
**请求**
~~~
put /api/v1/comment/comments/{commentIndexId}/{commentId}
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{commentIndexId}|String|
|{commentId}|String|
|[commentrequest](#commentrequest)|json|
**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data|[commentdo](#commentdo)|










#### 发送评论
**请求**
~~~
post /api/v1/comment/comments/{commentIndexId}/{commentId}/comments
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{commentIndexId}|String|
|{commentId}|String|
|[commentrequest](#commentrequest)|json|
**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data|[commentdo](#commentdo)|










#### 赞评论
**请求**
~~~
post /api/v1/comment/comments/{commentIndexId}/{commentId}/up
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{commentIndexId}|String|
|{commentId}|String|
|uid|String|
|[commentrequest](#commentrequest)|json|
**应答**


|字段|类型|说明|
|---|---|---|
|status||
|data||




#### 踩评论
**请求**
~~~
post /api/v1/comment/comments/{commentIndexId}/{commentId}/unup
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{commentIndexId}|String|
|{commentId}|String|
|[commentrequest](#commentrequest)|json|
**应答**


|字段|类型|说明|
|---|---|---|
|status|int|
|data|[commentdo](#commentdo)|








#### 回复评论
**请求**
~~~
post /api/v1/comment/comments/{commentIndexId}/{commentId}/report
~~~


**参数**


|字段|类型|说明|
|---|---|---|
|{commentIndexId}|String|
|{commentId}|String|
|[commentrequest](#commentrequest)|json|
**应答**


|字段|类型|说明|
|---|---|---|
|status||
|data||