关于 RESTful 的 「API 文档」


团队在用 Java Jersey 做 RESTful Web Service,随着接口的增加,文档化越来越重要。正在了解

有朋友用过,或者有其他推荐?

restful swagger rest raml

←═╬∞依樱 10 years, 1 month ago

个人觉得swagger比rap要好很多 rap的作者是阿里的霍雍 swagger在国外用的比较火,而且适用场景比较多,
单独为楼主弄了一个项目 基于swagger-ui springmvc 项目一下来就可以跑起来,我做了最简的优化,很容易去理解swagger-ui以及去改造它,它有权限控制等,mock数据有待开发,一切都是根据注解去书写文档,保证了文档和代码的一致性。
项目地址: https://github.com/mousycoder/server-api
希望楼主可以试试,或者我们可以一起开发。

刚出锅的包子 answered 10 years, 1 month ago

Swagger
可在线调试很方便

Tamakyi answered 10 years, 1 month ago

我再给一个备选项吧, apiary ,用markdown写api文档

我只是个宅 answered 10 years, 1 month ago

看云 -在线文档托管
现代化的UI,多级分类,单篇锚点,全文档搜索,可选的评论,在国内。
thinkphp文档: http://www.kancloud.cn/manual/thinkphp/1678
首页: http://www.kancloud.cn/

八意Yo琳 answered 10 years, 1 month ago

试一下阿里的rap写接口文档,我们公司在用,还可以

新酱小苦逼 answered 10 years, 1 month ago

Your Answer