paopao/docs/api doc/获取当前用户对某个动态的点赞状态接口.md

2.3 KiB
Raw Blame History

RESTFul API 文档

获取当前用户对某个动态的点赞状态

1 接口描述

获得当前登录用户对指定动态的点赞状态

2 请求URL

/v1/post/star

3 请求方式

GET

4 请求头

头字段 必填 数据类型 描述

1.5 Query参数

参数名称 必填 数据类型 约束条件 描述 示例 允许空值
id 长整型 文章id

6 请求示例

GET /v1/post/star?id=100

7 返回参数说明

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

data结构说明

参数名称 必填 数据类型 约束条件 描述
status boolean 已点赞 true, 未点赞 false

8 响应示例(成功)

 {
  "code": 0,
  "msg": "success",
  "data": {
    "status": true
  }
}

9 响应示例(错误)

{ "code": 10001, "msg": "验证码无效" }

10 错误响应码参考

更多响应错误码及含义,请参阅API响应码表

11 安全性与认证

此API要求调用方在Authorization头中携带经过Bearer认证的令牌。

12 测试环境

访问测试环境以进行接口调试: https://test.apiAddress.com

13 版本管理

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

14 更新记录

15 联系支持

如需帮助或对API有任何疑问请通过电子邮件与我们联系support@api.com

16 反馈与建议

发现文档问题或有改进建议?请填写反馈表单与我们分享。