【API编写】介绍一个国内强大的API接口文档写作网站showdoc
这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接生成api接口文档的网站,我又孤陋寡闻了,通过这几天的使用比较,我选定了showodc。
SHOWDOC
我本来用的apiary.io,全体也不错,而且是oralce收购的,发展应该可以,但是国外的服务器国内访问实在。。。。后来说在国内找一下,很幸运我发现了showdoc。
showdoc网站打开看着不起眼,但里面的内容相当的强大,重点说下特点
- 支持markdown语法(所有的api接口写作现在都支持这个吧,因为他现在太方便了)
- 支持多用户协作,你可以在项目下面随意添加多个用户一起完成api文档的写作。
- 可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览
- 支持响应式,手机电脑同样精彩
- 支持项目转让
- 支持模版插入
- 支持历史版本,你可以把操作恢复到以前的版本。