开发工具 [求推荐] 写 open api 的工具

niedhui · 2012年03月29日 · 最后由 liqiang123 回复于 2021年07月26日 · 4028 次阅读

各位有没有什么好用的 open api 工具啊 不是程序的 API 文档 而是对外开放的 API 文档 如 twitter, foursquare 的 open api 文档等 现在我们是把 open api 写在 wiki 里面,发现重复工作多,而具组织也不太顺。。

#1 楼 @fredwu 能简单分享下使用经验不?

匿名 #3 2012年03月29日

我为了现在的项目,写了个简单的 gem,http://github.com/bl0ckme/apidocbot 用起来还不错,不过通用性还不够

之前看到过这个https://github.com/zipmark/rspec_api_documentation,我没试过,你可以看看,文档最麻烦的就是不小心就忘记更新了

现在一个项目是直接用 yard 生成,代码注释在一起,更新都来方便,部署的时候跑个 yard 直接就可以在线查看。缺点是文件 80% 都是注释。当然这种方法需要你有东西可以注释,我是直接用的 rails 写的 API,每个 API 对应一个 action,每个 controller 对应一个 resource。至于 json 数据格式,用的 rabl,用了些 trick,其实就是每个 rabl 文件外面套个 class,让 yard 可以提取文档。

谢谢大家,找时间一个一个试试

lz 人间网最近啥动静?在用 ruby 做啥?方便说不?

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