Homeland 社区 API 开放接口问题反馈

jimneylee · 2013年12月25日 · 最后由 assyer 回复于 2014年01月24日 · 3454 次阅读

我在写RubyChina 客户端发现有几个 API 接口数据有问题,还需要坛主抽点时间完善下,具体问题反馈如下: 1、帖子回复列表 API: http://ruby-china.org/api/v2/topics/16194.json

  • a、回复列表未按 id 排序,会错乱,客户端可以做,但是建议在接口中处理。

    参照帖子:http://ruby-china.org/topics/16194

  • b、已删除的楼层,建议放一个占位数据 接口数据建议放一个占位数据,客户端解析发帖没有 id,认为帖子已删除。跟网页一致显示已删除。保证楼层跳转正确。

3、帖子 (取消) 关注成功返回是 json、(取消) 关注失败返回是 false,而收藏成功返回是 true or false API: http://ruby-china.org/api/v2/topics/:id/follow.json API: http://ruby-china.org/api/v2/topics/:id/unfollow.json API: http://ruby-china.org/api/v2/topics/:id/favorite.json 返回结果不统一,建议统一规范格式返回

4、个人主页接口中最近 5 条帖子的信息不完整 API: http://ruby-china.org/api/v2/users/:user.json

5、建议增加精华贴接口,这样方便大家通过客户端查阅社区优秀的帖子

6、http://ruby-china.org/api/v2/topics.json 默认是热门贴。 建议增加一个 type 类型,实现分类查看:默认 /  优质帖子 / 无人问津 / 最新创建

望采纳!Merry Christmas!

@huacnlee @lgn21st @Rei 请问方便完善下么,偶有点完美主义倾向,坛主们莫怪!

#1 楼 @jimneylee 你可以自己完善下再提交 pull request,grape api 还是很好改的

其实我喜欢的网站架构是 API+ 前端方式,这里的前端包括 (HTML5/CSS3/JS) 和 Android/iOS 客户端等,让 View 部分完全和业务分离,技术和物理上都分离。。。

#2 楼 @diudiutang 你的建议很不错。也是我学习 rails 的最佳实践,作为 2014 新年第一个月的学习任务。

#3 楼 @zeeler 恩,架构清晰,多终端并行开发。后端开发,我还是小白,后面多跟你们学习。

@huacnlee 今天测试发现,发帖接口返回的数据,已经改成跟回复类似的。其他接口有改动吗?

#6 楼 @jimneylee 请问,在开发 iOS 客户端的时候,有整理关于 API 的文档吗?最近想开发 Android 的版本,有 API 文档就好办了

需要 登录 后方可回复, 如果你还没有账号请 注册新账号