开源项目 关于 REST 和 JSON 格式的 API 文档的书写

pzgz · 2012年08月26日 · 最后由 fjarcticfox 回复于 2015年02月06日 · 9328 次阅读

这方面,大家有什么比较好的辅助工具么?

有个 Markdown 的 API 书写生成工具:https://github.com/filtersquad/emmett

另外,如果你用的是 Rails 的话,我的 API Taster 支持生成 API 以及注释:https://github.com/fredwu/api_taster

谢谢,你做的那个和我现在在项目里面做的很像,我一直希望的是接口名称和 JSON 的数据结构是自说明的,不过项目里面很难这样,一些老古董一定要文档,我最头疼的就是 JSON 数据的一个说明,觉得很繁琐

搜东西时找到这里。 未来的荣耀属于http://raml.org/,由社区共同维护的标准。 有个手动的 HTML 文档生成器 https://github.com/kevinrenskers/raml2html

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