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

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

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

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

我觉得这样有几个好处:

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

效果:





  • 2
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值