# RESTFul API 文档 

##  收藏和取消收藏接口

### 1 接口描述
收藏文章和取消对文章的收藏

### 2 请求URL
`/v1/post/collection`

### 3 请求方式
**POST**

### 4 请求头
| 头字段       | 必填 | 数据类型      | 描述                           |
| ------------ | ---- | ------------- | -------------------------------- |
| |   | ||

### 1.5 请求体参数
| 参数名称     | 必填 | 数据类型 | 约束条件 | 描述   | 示例        | 允许空值 |
|----------| ---- |------| ------- |------| ----------- | ----- |
| id       | 是   | 长整型  |  | 文章id |    |      |

### 6 请求示例
```http
POST /v1/post/star
Host: {apiAddress}
Content-Type: application/json

{
    "id": 123440
}
```

### 7 返回参数说明
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述                        |
|------| ---- | -------- | -------- | ---------------------------- |
| code | 是   | 整型   | | 错误码，200表示成功 |
| msg  | 否   | 字符串   | 1-50字符 | 错误信息描述     |
| data | 否  | json  |   | 具体业务数据          |

data结构说明：

| 参数名称   | 必填 | 数据类型    | 约束条件                    | 描述        |
|--------| ---- |---------|-------------------------|-----------|
| status | 是  | boolean | 收藏成功 true, 取消收藏成功 false | |


### 8 响应示例（成功）

```json
 {
  "code": 0,
  "msg": "success",
  "data": {
    "status": true
  }
}
```
### 9 响应示例（错误）
```json
{ "code": 10001, "msg": "验证码无效" }
```

### 10 错误响应码参考
更多响应错误码及含义，请参阅[API响应码表](URL/for/api/responseCode/table)。

### 11 安全性与认证
此API要求调用方在`Authorization`头中携带经过Bearer认证的令牌。

### 12 测试环境
访问测试环境以进行接口调试：
[https://test.apiAddress.com](https://test.apiAddress.com)

### 13 版本管理
本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。

### 14 更新记录


### 15 联系支持
如需帮助或对API有任何疑问，请通过电子邮件与我们联系：[support@api.com](mailto:support@api.com)。

### 16 反馈与建议
发现文档问题或有改进建议？请填写[反馈表单](https://forms.api.com/feedback)与我们分享。