coolq-http-api 在现有的 API 之外提供一套新的 RESTful API

在现有的 API 之外提供一套新的 RESTful API

Open stdrc opened this issue 7 years ago • 10 comments

Feb 22 '17 07:02 stdrc

初步设计：

GET    /r/info                                 # 获取登录号信息

GET    /r/friends                              # 好友列表
GET    /r/friends/1002647525                   # 好友信息（如果不在好友列表中则返回 404）
POST   /r/friends/1002647525/message           # 发送私聊消息

GET    /r/groups                               # 群组列表
GET    /r/groups/530812134                     # 群组信息
PUT    /r/groups/530812134                     # 更改群组设置（允许匿名、全员禁言等）
DELETE /r/groups/530812134                     # 退出／解散群组
POST   /r/groups/530812134/message             # 发送群消息

GET    /r/groups/530812134/members             # 群成员列表
GET    /r/groups/530812134/members/1002647525  # 群成员信息
PUT    /r/groups/530812134/members/1002647525  # 更改群成员信息（群名片、是否管理员、禁言等）
DELETE /r/groups/530812134/members/1002647525  # 踢出群成员

POST   /r/discusses/1728197705/message         # 发送讨论组消息
DELETE /r/discusses/1728197705                 # 退出讨论组

GET    /r/users/1002647525                     # 陌生人信息（如果在好友列表则返回好友信息，更详细）
POST   /r/users/1002647525/message             # 发送私聊／临时消息（等同于 /friends/1002647525/message）
POST   /r/users/1002647525/like                # 发送赞

Feb 22 '17 08:02 stdrc

发送消息的 API 用 POST /friends/123456/messages 这样可能更好（messages 使用复数）？

「更改群组设置」和「更改群成员信息」也许用 PATCH 更合理。另外，也可以把这里所谓的「设置」都分离出来，作为 /groups/12345 的子资源，如 /groups/12345/banned、/groups/12345/members/123456/banned、/groups/12345/anonymous，这里需要详细判断一下，像对于群成员信息那一条，可能使用 PATCH 来直接更新会更直观一些

Feb 25 '17 12:02 stdrc

支持...