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

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

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

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

我觉得这样有几个好处：

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

效果：

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

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

推荐一个好用的文档管理服务器-showdoc
一个好用的文档管理服务器-showdoc 一.服务器安装先看使用效果. 文档记录的作用对我们技术人来说是十分重要的.好的文档记录能让我们面对之前出现过的类似问题时候,事半功倍.不至于捡芝麻丢西瓜,一 ...
几款接口文档管理工具
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
接口文档管理工具-Postman、Swagger、RAP、DOClever
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
接口文档管理工具-Postman、Swagger、RAP
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
强烈推荐在线接口文档管理工具小幺鸡小团队可以省掉测试了
在朋友那儿看到一个不错的在线文档管理工具主要特点 : 在线接口测试在线测试,方便前后端开发,降低错误率. 支持:xml.json.txt.binary.websocket 可视化编辑与分享可视化 ...
【工具】目前几种常见的线上接口文档管理平台的比较
文章目录一.前言二.接口文档在线平台 1.apizza 1.1 文档导出html 1.2 导入Postman.json和Swagger.json文件 2. YApi 2.1 源码开源&免费 ...
盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
一款强大的API接口文档管理工具（Smart-Doc + Torna）
[本文由龙飞同学供稿] 在团队协作开发项目的时候,接口文档承担着向其他开发人员说明接口相关信息的重要任务,因此,一份清晰而又相近的接口文档至关重要. 但是,写接口文档的痛苦想必各位开发人员都体验过,明 ...
如何维护接口文档供外部调用——在线接口文档管理
上个章节初步将一个应用运行起来,由于服务不会单独存在,服务开发团队必然与其他服务团队进行服务调用,暴露出对外接口势在必行.早期做开发的时候,大家习惯于以 word 或 excel 的形式,但弊端显而易 ...

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

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

最新文章

热门文章