推荐一个公司内部接口文档管理方案

我觉得比较适合小公司,尤其适合开发app的小公司。

文档内容用markdown语法写,然后提交到自己的git服务器(基于gitolite搭建的)。

然后在服务器上部署一个java的web应用(就是我要推荐哒,我们就部署在随便一个tomcat里了),它用于将md文件展示成html效果。

我觉得这样有几个好处:

  • 这些文档可以对比历史(有些责任不再划分不清)
  • 这个应用也很小(解压完700+KB)没有使用任何框架(均采用java原声的servlet、filter)
  • 支持权限限制,不登陆无法查看任何文档(便于放在公网服务器上,远程办公)
  • 公司里可能有很多项目,每个项目的接口文档可以分开管理权限
  • 开源(https://github.com/sunzsh/markdown-doc-server)

效果:
推荐一个公司内部接口文档管理方案_第1张图片

推荐一个公司内部接口文档管理方案_第2张图片

下载地址: http://download.csdn.net/detail/sunzeshan/9529169

你可能感兴趣的:(推荐一个公司内部接口文档管理方案)