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

niedhui · 2012年03月29日 · 最后由 yuan 回复于 2012年04月02日 · 3318 次阅读

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

共收到 7 条回复

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

我为了现在的项目,写了个简单的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做啥?方便说不?

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