Blame view

inferface-document/guang/articleTag.md 3.59 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
标签管理接口服务定义
---------------------



## 标签列表查询

> 接口名: '/guang/tags/getList'

### 入参

-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|tagName|String|运动|标签名称|
|classifyId|int|1|分类名称|
|isHot|int|1|是否热门|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"操作成功",
    "data": {
        "list": [
            {
                "id": "1",          //标签ID  
                "tagName": "运动",  //标签名称
                "classifyId": "2",  //分类ID
                "isHot": "1",       //是否热门,0非热门,1热门
                "status": "1",      //状态,0关闭,1开启
34 35 36
                "createTime": "1432113792", //创建时间
                "cover":"xxx.png",
                "orderBy":"1"
37 38 39 40 41 42 43 44 45 46 47 48
            }
        ]
    }
}

```


## 添加标签接口

> 接口名: '/guang/tags/addTag'
49 50
`Note: 上传图片 Bucket 用 articleTags`
51 52 53 54 55 56 57 58 59
### 入参

-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|tagName|String|运动|标签名称|
|classifyId|int|1|分类ID|
|isHot|int|1|是否热门|
|status|int|1|是否启用|
60 61
|cover |string|http://img11.static.yhbimg.com/plustar/2016/04/19/02/019be7398cad5ac1e2170938d3d2d02e20.jpg|封面|
|orderBy |int|1|排序|
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
---------------------

### 返回

``` json
{
    "code":200,
    "message":"添加成功!"
}

```


## 编辑标签接口

> 接口名: '/guang/tags/updateTag'

### 入参

-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|1|标签ID|
|tagName|String|运动|标签名称|
|classifyId|int|1|分类ID|
|isHot|int|1|是否热门|
|status|int|1|是否启用|
89 90
|cover |string|http://img11.static.yhbimg.com/plustar/2016/04/19/02/019be7398cad5ac1e2170938d3d2d02e20.jpg|封面|
|orderBy |int|1|排序|
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
---------------------

### 返回

``` json
{
    "code":200,
    "message":"修改成功!"
}

```

## 编辑时标签详情接口

> 接口名: '/guang/tags/getDetail'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|id|int|1|标签id|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"操作成功",
    "data": {
            "id": "1",          //标签ID  
            "tagName": "运动",  //标签名称
            "classifyId": "2",  //分类ID
            "isHot": "1",       //是否热门,0非热门,1热门
            "status": "1",      //状态,0关闭,1开启
127 128 129
            "createTime": "1432113792", //创建时间
            "cover": "http://img11.static.yhbimg.com\\plustar/2016/04/19/02/019be7398cad5ac1e2170938d3d2d02e20.jpg",
            "orderBy": 1
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
        }
}

```


## 删除标签接口

> 接口名: '/guang/tags/delTag'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|id|int|1|标签id|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"删除成功!"
}

```

## 新增或编辑时获取标签分类列表

> 接口名: '/guang/tagSort/getTagItems'

### 入参

-------------------------
|属性名称|类型|例子|说明| 
|--------|----|----|----|
|status|int|1|开启状态的分类|
---------------------

### 返回

``` json
{
    "code":200,
    "message":"操作成功",
    "data": [
        {
            "id": "1",
            "text":"搭配风格"
        }
    ]

}
185
```