造物app前台及后台API接口-不凡学院

造物app前台及后台API接口

2019-08-09 16:53 1571 6

[TOC]
# 页面前端接口部分
- 接口说明: 造物app的前台及后台接口.后台接口以/admin/xx开始.
- ${host}= http://www.bufantec.com/api/zaowu
- app设计稿可以通过添加微信 bufanxueyuan 获取
- 接口用于学习测试,部分接口尚未完善,如有问题欢迎反馈
- <a href="http://www.bufantec.com/site/zaowu-%E9%80%A0%E7%89%A9-m">预览地址</a>

### 用户接口

#### 1. 用户注册

- **请求URL**
> [${host}/user/doRegister](#)

- **请求方式** 
>**POST**

- **请求参数**

```javascript
 //针对post接口的说明,类似与user.username的请求参数,用jquery举例 
  $.ajax{
      type:'post'
      data:{
        user:{
        username: '张三',
        password: '1234'
      }
    }
  }

```

- **返回参数**

- **返回示例**
   
 
```java 
{
  "code": "S",
  "data": {
    msg:"注册成功!"
}

```

####   2. 用户登录

- **请求URL**
> [${host}/user/doLogin](#)

- **请求方式** 
>**POST**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {
    msg:"登录成功!"
}
```

####   2. 检查用户名是否可用

- **请求URL**
> [${host}/user/checkUserName](#)

- **请求方式** 
>**POST**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {
    msg:""
}
```

### 分类页面
####   1. 分类列表

- **请求URL**
> [${host}/kind/list](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": [
        {
            id:"xxxx",
            title:"chuangyi",
            ctitle:"创意",
            img:"xxx.jpg"
            subKind:[
                {
                    code:"001",
                    title:"wazi",
                    ctitle:"袜子"
                },
                {
                    code:"002",
                    title:"weijin",
                    ctitle:"围巾"
                },
            ]
        
        },
        {
                    id:"xxxx",
                    title:"neiyi",
                    ctitle:"内衣",
                    img:"xxx.jpg"
                    subKind:[
                        {
                            code:"001",
                            title:"wazi",
                            ctitle:"袜子"
                        },
                        {
                            code:"002",
                            title:"weijin",
                            ctitle:"围巾"
                        },
                    ]
                
                },
  
  ]
```

####   2. 根据分类id获取商品列表

- **请求URL**
> [${host}/kind/goodsListByKind](#)

- **请求方式** 
>**get**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": [
        {
            id:"xxxx",
            title:"纯棉围巾",
            cover:"xxx.jpg"
        },
         {
            id:"xxxx",
            title:"电脑箱包",
            cover:"xxx.jpg"
        },
  
  ]
```

####   4. 查看商品明细

- **请求URL**
> [${host}/kind/goodsDetail](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |
| id | String | false | 商品id |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":  {
              id:"xxxx",
              name:"纯棉围巾",
              brand:"热风",
              imgs:[
                "a.jpg",
                "b.jpg"
              ],
              attrs:[
                {
                   code: "001",
                   size:"s",
                   color: "#666",
                   lastCount: 999
                
                },
                {
                   code: "002",
                   size:"s",
                   color: "#333",
                   lastCount: 10
                },
                {
                   code: "003",
                   size:"M",
                   color: "#333",
                   lastCount: 0
                }
              
              ]
              
          }
```

### 评价信息
####  1. 查看商品评价

- **请求URL**
> [${host}/comments/list](#)

- **请求方式** 
>**get**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":  [
        {
           id:"xxx",
           goodsId:"xxx",
           name:"zs",
           star:5,
           comment:"这件衣服不错!",
           ts:12394812348  //时间戳    
        },
        {
           id:"xxx",
           goodsId:"xxx",
           name:"不凡君",
           star:3,
           comment:"很愉快的一次购物!",
           ts:12394812348  //时间戳    
        },
           
  ]
```

####  2. 查看商品评价

- **请求URL**
> [${host}/comments/save](#)

> [${host}/comments/update](#)

- **请求方式** 
>**post**

- **请求参数**

- **返回参数**

- **返回示例**
    
```java 
{
  "code": "S",
  "data": {}
```

####  3. 删除商品评价

- **请求URL**
> [${host}/comments/del](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |
| id | String | false | 评价id |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {}
```

### 我的

####   1. 获取地址列表 (暂未实现)

- **请求URL**
> [${host}/my/address/list](#)

- **请求方式** 
>**get**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":[
        {
            userId:"xxx",
            name:"李先生",
            tag:"公司",
            p:"河南省",
            c:"郑州市",
            t:"郑东新区",
            bak: "金水路东风南路绿地新都会",
            tel: "1234234",
            use:true, //是否默认
            addTime: 1234234
        },
        {
        
        }
  ]
```

####   2. 新增/修改地址信息 (暂未实现)

- **请求URL**
> [${host}/my/address/save](#)

> [${host}/my/address/update](#)

- **请求方式** 
>**post**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":{}
```

####  3.删除地址  (暂未实现)
- **请求URL**
> [${host}/my/address/del](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |
| id | String | false | 地址id |

- **返回参数**

- **返回示例**
  
```java 
{
  "code": "S",
  "data":{}
```

####  4.设置默认  (暂未实现)
- **请求URL**
> [${host}/my/address/setOne](#)

- **请求方式** 
>**post**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |
| id | String | false | 地址id |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":{}
```

---

# 后台接口
### 系统接口

#### 1. 查询数据词典  (暂未实现)

- **请求URL**
> [${host}/sys/dict/list](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": [{
        {
            id: "xxx",
            name:"郑州",
            code: "001",
            pcode: "001",
            desc:""
        },
        {
            id: "xxx",
            name:"洛阳",
            code: "002",
            pcode: "001",
            desc:""
        }
  ]

```

#### 2. 数据词典添加 (暂未实现)

- **请求URL**
> [${host}/sys/dict/save](#)

> [${host}/sys/dict/update](#)

- **请求方式** 
>**post**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":{
       msg:""
  }

```

#### 3. 数据词典删除 (暂未实现)

- **请求URL**
> [${host}/sys/dict/del](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数   |  能否为空  |   参数说明   |
| :--------: | :---------: | :------: |
| id|  false | |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":{
       msg:""
  }

```

### 商品信息管理页面

#### 1. 商品信息列表

- **请求URL**
> [${host}/admin/goods/list](#)

- **请求方式** 
>**get**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": [
          {
              id: "xxx",
              brand: "热风",
              name: "裤子",
              priceIn: 200.00,  // 进价
              priceNow: 210.00, // 现价/打折
              priceOut: 220.00, // 卖出价格
              lastCount: 999, //库存
              hot: 0, // 0 正常,1 热卖
              addTime: 1234234,
          
          },
          {
                id: "xxx",
                brand: "热风",
                name: "裤子",
                priceIn: 200.00,  // 进价
                priceNow: 210.00, // 现价/打折
                priceOut: 220.00, // 卖出价格
                lastCount: 999, //库存
                hot: 0, // 0 正常,1 热卖
                addTime: 1234234,
            
            },
    
    ]

```

#### 2. 商品信息添加

- **请求URL**
> [${host}/admin/goods/save](#)

> [${host}/admin/goods/update](#)

- **请求方式** 
>**post**

- **请求参数**

| 请求参数     |  能否为空  |   参数说明   |
| :--------:| :---------: | :------: |
| goods.id|  | 商品id,修改时 必须 |
| goods.kindId|  | 分类id,必须先有分类 |
| goods.brandId| false | 品牌id |
| goods.name | false | 名称 |
| goods.desc | false | 描述 |
| goods.priceIn | false | 进价 |
| goods.priceOut | false | 卖出价格 |
| goods.priceNow | false | 打折/当前价格 |
| goods.hot   |  | 0 默认 ,1 为热卖 |
| goods.img1   |  | banner 轮播图1 |
| goods.img2   |  | banner 轮播图2 |
| goods.img3   |  | banner 轮播图3 |
| goods.color1   |  | 颜色1, #000000 ,十六进制 |
| goods.color2   |  | 颜色2, #000000 ,十六进制 |
| goods.color3   |  | 颜色3, #000000 ,十六进制 |
| goods.size_s   |  |  0 为不存在,1 为存在|
| goods.size_m   |  |  0 为不存在,1 为存在|
| goods.size_l   |  |  0 为不存在,1 为存在|
| goods.contentSource || 商品页面描述信息,富文本原内容|
| goods.content || 商品页面描述信息,富文本转换后html|

- **返回参数**

- **返回示例**
    
```java 
{
  "code": "S",
  "data": {}

```

#### 3. 商品信息删除

- **请求URL**
> [${host}/admin/goods/del](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数     |  能否为空  |   参数说明   |
| :--------:| :---------: | :------: |
| id|  | 商品id,修改时 必须 |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {}

```

#### 4. 二级商品信息

- **请求URL**
> [${host}/admin/goods/stockList](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |
| id | | |商品id |

- **返回参数**

```

#### 5. 商品库存信息添加

- **请求URL**
> [${host}/admin/goods/saveStock](#)

> [${host}/admin/goods/updateStock](#)

- **请求方式** 
>**post**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {}

```

#### 6. 删除商品库存信息

- **请求URL**
> [${host}/admin/goods/delStock](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数     |  能否为空  |   参数说明   |
| :--------:| :---------: | :------: |
| id|  | 库存信息id |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {}________

```

#### 7. 根据id查询商品信息

- **请求URL**
> [${host}/admin/goods/goodsDetail](#)
> [${host}/admin/goods/goodsStockDetail](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数     |  能否为空  |   参数说明   |
| :--------:| :---------: | :------: |
| id| false |  |

- **返回参数**

- **返回示例**
    
```java 
{
  "code": "S",
  "data": {}________

```

### 分类页面接口

#### 1. 分类展示

- **请求URL**
> [${host}/admin/kind/list](#)

- **请求方式** 
>**get**

- **请求参数**

| 请求参数      |   参数类型 |  能否为空  |   参数说明   |
| :--------: | :--------:| :---------: | :------: |

- **返回参数**

- **返回示例**
    
```java 
{
  "code": "S",
  "data": [
          {
              id:"xxxx",
              title:"chuangyi",
              ctitle:"创意",
              img:"xxx.jpg"
              subKind:[
                  {
                      id:"xx",
                      title:"wazi",
                      ctitle:"袜子",
                      level:1
                  },
                  {
                      id:"xx",
                      title:"weijin",
                      ctitle:"围巾",
                      level:2
                  },
              ]
          
          },
          {
              id:"xxxx",
              title:"neiyi",
              ctitle:"内衣",
              img:"xxx.jpg"
              subKind:[
                  {
                      id:"xx",
                      title:"wazi",
                      ctitle:"袜子",
                      level:1
                  },
                  {
                     id:"xx",
                      title:"weijin",
                      ctitle:"围巾",
                      level:2
                  },
              ]
          
          },
    
    ]

```
#### 2. 分类页面添加分类

- **请求URL**
> [${host}/admin/kind/save](#)

> [${host}/admin/kind/update](#)

- **请求方式** 
>**post**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":{}

```

#### 2. 分类页面删除分类

- **请求URL**
> [${host}/admin/kind/del](#)

- **请求方式** 
>**get**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data":{}

```

### 上传管理

#### 1. 图片上传

- **请求URL**
> [${host}/admin/upload](#)

- **请求方式** 
>**post**

- **请求参数**

| 请求参数     |   能否为空  |   参数说明   |
| :--------: |:---------: | :------: |

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {}

```

### 订单管理页面 (暂未实现)

#### 1. 订单列表

- **请求URL**
> [${host}/admin/order/list](#)

- **请求方式** 
>**get**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {}

```

#### 2. 修改订单状态

- **请求URL**
> [${host}/admin/order/updateState](#)

- **请求方式** 
>**get**

- **请求参数**

- **返回参数**

- **返回示例**
   
```java 
{
  "code": "S",
  "data": {}

```

上一篇: 2019 年最受欢迎的10个 JavaScript 动画库下一篇: 在前端开发中值得推荐的常用工具

扫码分享此文章