扯淡背景篇:
这几天要写一个接口API文档,想来要弄也,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接生成API接口文档的网站,我又孤陋寡闻了,通过这几天的使用比较,我选定了showodc。
showdoc网站打开看着不起眼,但里面的内容相当的强大,重点说下特点
1:支持markdown语法(所有的api接口写作现在都支持这个吧,因为他现在太方便了)
2:支持多用户协作,你可以在项目下面随意添加多个用户一起完成api文档的写作。
3:可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览
4:支持响应式,手机电脑同样精彩
5:支持项目转让
6:支持模版插入
7:支持历史版本,你可以把操作恢复到以前的版本。
8:完全开源
9:可以部署到自己的服务器
10:如果在线使用,可以设置自己的个性域名,也可以对文档进行加密,浏览者需要密码才能访问
11:可以通过一个在线测试api的工具,直接生成markdown,你几乎不用写代码就能过所有的参数自动生成
看一些页面:


看到这里,基本上就结束了,因为从这个项目我得到了启发,为啥我不用C# asp.net mvc 开发一个项目。
一个人的QQ群:721420150(点击加入下吧)
如果你看到欢迎你加入哦,毕竟人真的少的可怜。
网友评论