EOSFans API 目录

0 条评论 , 0 次修正,1191 次阅读, 最后更新于 2018年07月26日

基础-Root

简单的 API 测试接口

简单的 API 测试接口,需要验证,便于快速测试 OAuth 以及其他 API 的基本格式是否正确

GET /api/v3/hello

Response

UserDetailSerializer

帐号

获取热门用户

GET /api/v3/users

Parameters

  • limit (Integer)  - default: 20,range: 1..100

Response

Array<UserSerializer>

获取某个用户的详细信息

获取 :id 用户的详细信息

GET /api/v3/users/:id

Response

UserDetailSerializer

获取当前用户的完整信息

用于个人设置修改资料

GET /api/v3/users/me

Response

UserDetailSerializer

用户回帖列表

获取某个用户的回帖列表

GET /api/v3/users/:id/replies

用户的话题列表

获取某个用户发布的话题列表

GET /api/v3/users/:id/topics

Parameters

  • order (String) - 排序方式, default: 'recent', range: %w(recent likes replies)
  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<TopicSerializer>

屏蔽用户

当前用户屏蔽 :id 的用户

POST /api/v3/users/:id/block

取消屏蔽用户

当前用户取消屏蔽 :id 的用户

POST /api/v3/users/:id/unblock

获取当前用户的屏蔽列表

获取当前用户的已屏蔽的人(只能获取自己的)

GET /api/v3/users/:id/blocked

Parameters

  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<UserSerializer>

关注用户

当前用户关注 :id 的用户

POST /api/v3/users/:id/follow

取消关注

当前用户取消对 :id 用户的关注

POST /api/v3/users/:id/unfollow

获取用户的关注列表

获取 :id 的用户的关注列表

GET /api/v3/users/:id/following

Parameters:

  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<UserSerializer>

获取用户的关注者列表

获取关注 :id 用户的人的列表

GET /api/v3/users/:id/followers

Parameters:

  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<UserSerializer>

获取某个用户的收藏列表

获取 :id 用户收藏的话题列表

GET /api/v3/users/:id/favorites

Parameters:

  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<TopicSerializer>

节点 - Node

获取节点列表

GET /api/v3/nodes

Response

Array<NodeSerializer>

节点详情

获取单个 Node 详情

GET /api/v3/nodes/:id

Response

NodeSerializer

话题 - Topics

获取话题列表

获取话题列表,类似 EOSFans 话题列表的内容,支持多种排序方式。

GET /api/v3/topics

Parameters:

  • type (String) - 排序类型, default: last_actived, %w(last_actived recent no_reply popular excellent)
  • node_id (Integer) - 节点编号,如果有给,就会只去节点下的话题
  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<TopicSerializer>

话题详情

获取话题详情(不含回帖)

GET /api/v3/topics/:id

Response

TopicDetailSerializer

创建新话题

创建一篇新的话题

POST /api/v3/topics

Parameters:

  • title (String) — 标题, [required]
  • node_id (Integer) — 节点编号, [required]
  • body (Markdown) — 格式的正文, [required]

Response

TopicDetailSerializer

修改话题

修改话题内容

PUT /api/v3/topics/:id

Parameters

  • title (String) — 标题, [required]
  • node_id (Integer) — 节点编号, [required]
  • body (Markdown) — 格式的正文, [required]

Response

TopicDetailSerializer

删除话题

删除一篇话题

DELETE /api/v3/topics/:id

创建回帖

创建对 :id 话题的回帖

POST /api/v3/topics/:id/replies

Parameters

  • body (String) - 回帖正文

Response

ReplySerializer

话题的回帖列表

获取话题的回帖列表

GET /api/v3/topics/:id/replies

Parameters

  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<ReplySerializer>

关注话题

POST /api/v3/topics/:id/follow

取消关注话题

POST /api/v3/topics/:id/unfollow

收藏话题

POST /api/v3/topics/:id/favorite

取消收藏话题

POST /api/v3/topics/:id/unfavorite

话题动作接口

:id 这篇话题发起动作(屏蔽、加精华、结束讨论...) 注意类型有不同的权限,详见 GET /api/v3/topics/:id 返回的 abilities

POST /api/v3/topics/:id/action?type=:type

Parameters:

  • type (String) — 动作类型, ban - 屏蔽话题, excellent - 加精华, unexcellent - 去掉精华, close - 关闭回复, open - 开启回复

回帖-Replies

获取回帖的详细内容

获取回帖的详细内容(一般用于编辑回帖的时候)

GET /api/v3/replies/:id

Response

ReplyDetailSerializer

修改回帖

POST /api/v3/replies/:id

Parameters

  • body (String) - 回帖内容 [required]

Response

ReplyDetailSerializer - 更新过后的数据

删除回帖

DELETE /api/v3/replies/:id

图片附件 - Photos

上传附件

上传图片,请使用 Multipart 的方式提交图片文件.

POST /api/v3/photos

Parameters

  • file - 文件信息, [required]

Response

{
  image_url: '图片 URL',
}

点赞 - Likes

点赞可以针对 话题(topic)或回帖(reply)发起。

点赞

对话题/回帖点赞

POST /api/v3/likes

Parameters

  • obj_type (String) — 类型 [topic, reply]
  • obj_id (Integer) — 对应数据的编号

Response

  • count [Integer] 已赞的数量

取消赞

取消之前的赞

DELETE /api/v3/likes

Parameters

  • obj_type (String) — 类型 [topic, reply]
  • obj_id (Integer) — 对应数据的编号

通知 - Notifications

获取用户的通知列表

GET /api/v3/notifications

Parameters

  • offset (Integer) - default: 0
  • limit (Integer) - default: 20, range: 1..150

Response

Array<NotificationSerializer>

批量将通知设成已读状态

将当前用户的一些通知设成已读状态

POST /api/v3/notifications/read

Parameters

  • ids (Array) - 需要设为已读的通知编号列表(只能是当前用户的) [required]

获取未读通知数量

获得未读通知数量

GET /api/v3/notifications/unread_count

删除某个通知

删除当前用户的某个通知

DELETE /api/v3/notifications/:id

清空通知

删除当前用户的所有通知

DELETE /api/v3/notifications/all