在项目中，需要协同开发，所以会写许多API文档给其他同事，以前都是写一个简单的TXT文本或Word文档，口口相传，这种方式比较老土了，所以，需要有个api管理系统专门来管理这些api，从网上找了许多比较好的开源文档管理系统，可以应用到项目中。

1、国外的话Swagger

swagger-ui

2、国内的Showdoc

国内开源的非常好用的一款API文档管理系统，安装也非常方便，只需将源代码放到项目目录下自动安装运行即可，不要要注意PHP版本必须大于5.3.

3、界面简洁功能强大的EOAPI

4、阿里的RAP

Web API management, free and open sourced, mock data generator, auto test, made by Alibaba, using by 1000+ corporations! Web接口管理工具，开源免费，接口自动化，MOCK数据自动生成，自动化测试，企业级管理。阿里妈妈MUX团队出品！阿里巴巴都在用！1000+公司的选择！一直被抄袭，从未被超越 :3 http://rapapi.net

6、docute: 无需编译的文档撰写工具

像 gitbook 之类的工具需要编译后发布，而 docute 让你直接写 markdown 文件作为文档来显示而不需要编译成 html 这一步，你的文档目录里只需要一个首页 index.html 和你的配置文件 config.js。

docute 会直接渲染这些 markdown 文件为一个单页应用。配合 github pages 发布到 ./docs 目录效果更佳，当然发布到任何地方都可以。

CrapApi：一个由angularjs+bootstrap+springMVC搭建的高性能的免费开源的API接口、文档管理系统（应用接口管理系统）

主要功能：api接口管理、数据字典管理、接口数据模拟、接口文档管理（支持markdown、kindereditor等编辑器）、支持本地部署或在线使用、支持通过建表语句导入数据字典...

其他功能：项目管理、用户管理、模块管理、接口管理、接口版本管理、接口拷贝、接口文档pdf下载、接口mock、模块加密访问、

接口在线调试、数据字典管理、数据字典加密访问多管理员、多权限、多角色管理、自定义菜单、自定义网站样式、文档留言、

错误码管理、接口排序、DOC、PDF、TEXT、EXCEL等资源管理、支持版本号控制、文档内容检索、操作日志记录、

根据日志恢复数据、markdown编辑器、kindeditor编辑器、angularjs编辑器、Lucene搜索、项目成员管理...

10、 TeaKKi

这个WIKI用来写文档也不错~

TeaKKi == team wiki, https://teakki.com 超越了wiki, 在wiki基础上支持团队知识协作

这个需要在编辑后生成静态的HTML页面，然后上传到服务器。

具体步骤：

Windows安装方法：

1、官网nodejs.org下载Node

2、安装

3、将npm 替换为淘宝镜像cnpm

C:\Users\Administrator>npm install -g cnpm --registry=https://registry.npm.taobao.org

4、使用cnpm安装apidoc

C:\Users\Administrator>cnpm install apidoc -g

安装的地址：

[apidoc@0.17.5] link C:\Users\Administrator\AppData\Roaming\npm\apidoc@ -> C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\bin\apidoc

C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc

监控api_doc.json文件改变，然后自动生成HTML

watch.js文件，然后node 执行该文件

/**

* watch.js

* Created by lincoln on 16-1-6.

*/

var gaze = require('gaze');

var exec = require('child_process').exec;

var fs = require('fs')

function init(){

fs.mkdirSync('./api');

fs.mkdirSync('./doc');

createConfigureFile();

beginWatch();

}

/**

{

"name": "测试",

"version": "0.0.1",

"description": "API文档测试",

"title": "API文档测试",

"url" : "http://121.41.44.218",

"sampleUrl" : "http://121.41.44.218",

"template":{

"forceLanguage":"zh-cn"

}

}

*/

function createConfigureFile(){

var configure = {

"name": "测试",

"version": "0.0.1",

"description": "API文档测试",

"title": "API文档测试",

"url" : "http://xxxxxx",

"sampleUrl" : "http://xxx",

"template":{

"forceLanguage":"zh-cn"

}

}

fs.writeFileSync('./api/apidoc.json',JSON.stringify(configure));

}

function beginWatch(){

gaze('./api/*.*',function(error,watcher){

this.on('all', function(event, filepath) {

console.log(filepath + ' was ' + event);

runGeneartion();

})

});

}

function runGeneartion(){

var com = exec('apidoc -i ./api -o ./doc ')

com.stdout.on('data', function (data) {

console.log("生成Api->"+data);

});

com.stderr.on('data', function (data) {

console.log('生成错误啦->' + data);

});

}

if(fs.existsSync('./api') && fs.existsSync('./doc')){

beginWatch();

}else{

init();

}

安装gaze包，然后执行watch.js文件：

➜ apidoc cnpm install gaze

[gaze@*] installed at node_modules/.1.1.2@gaze (14 packages, use 2s, speed 54.93kB/s, json 85.75kB, tarball 0B)

All packages installed (14 packages installed from npm registry, use 2s, speed 54.62kB/s, json 17(85.75kB), tarball 0B)

➜ apidoc node watch.js

/WEB/apidoc/api/apidoc.json was changed

生成Api->info: Done.

api参数：

Usage: C:\Program Files\nodejs\node.exe apidoc [options]

Options:

-f, --file-filters RegEx-Filter to select files that should be parsed (multiple -f can be used)

-e, --exclude-filters RegEx-Filter to select files / dirs that should not be parsed (many -e can b

-i, --input Input / source dirname. [./]

-o, --output Output dirname. [./doc/]

-t, --template Use template for output files. [C:\Users\Administrator\AppData\Roaming\npm\

-c, --config Path to directory containing config file (apidoc.json) [./]

-p, --private Include private APIs in output. [false]

-v, --verbose Verbose debug output. [false]

-h, --help Show this help information.

--debug Show debug messages. [false]

--color Turn off log color. [true]

--parse Parse only the files and return the data, no file creation. [false]

--parse-filters Optional user defined filters. Format name=filename

--parse-languages Optional user defined languages. Format name=filename

--parse-parsers Optional user defined parsers. Format name=filename

--parse-workers Optional user defined workers. Format name=filename

--silent Turn all output off. [false]

--simulate Execute but not write any file. [false]

--markdown Turn off default markdown parser or set a file to a custom parser. [true]

--line-ending Turn off autodetect line-ending. Allowed values: LF, CR, CRLF.

--encoding Set the encoding of the source code. [utf8]. [utf8]

执行生成文档命令

D:\code\api_doc>apidoc -i example/ -o doc/

info: Done.

D:\POCO\api_doc>

截图：

这个开源的文档界面看起来还挺不错。

15、线上文档

①、阿里的 语雀

②、腾讯的 乐享

③、confluence

④、Mindoc

python api文档管理工具_开源的api文档管理系统相关推荐

1. 开源在线文档编辑工具_开源暑期实习，在线教育新工具等

   开源在线文档编辑工具 开源新闻让您阅读愉快. 2014年2月24日至28日 在本周的开源新闻摘要中,我们将介绍慕尼黑在转储专有软件,Mozilla的移动Firefox OS上的隐私等方面的进展. 慕尼 ...

2. wordContrl word文档管理工具

   wordContrl 介绍 word文档管理工具,具有创建word文档.编辑word文档.将word文档转为文本等功能 软件架构 软件架构说明 安装教程 xxxx xxxx xxxx 下载地址:git ...

3. 盘点 8 款好用的 API 接口文档管理工具

   随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...

4. API文档管理工具折射出的技术视野

   什么是技术视野 网上看到不少关于如何提升技术视野的讨论,但却没有人给出定义,到底什么是技术视野? 所谓技术视野,就是看问题时所能切换的不同角(维)度. 下面就以API管理工具(以下简称"管理 ...

5. 一个让我欲罢不能的开源文档管理工具

     大家好,我是小编南风吹,每天推荐一个小工具/源码,装满你的收藏夹,让你轻松节省开发效率,实现不加班不熬夜不掉头发!   今天小编推荐一款在线文档工具,现有swagger 文档.dubbo文档.数据 ...

6. 强烈推荐 在线接口文档管理工具 小幺鸡 小团队可以省掉测试了

   在朋友那儿看到一个不错的在线文档管理工具 主要特点 : 在线接口测试 在线测试,方便前后端开发,降低错误率. 支持:xml.json.txt.binary.websocket 可视化编辑与分享 可视化 ...

7. java接口文档生成工具_【分享】接口文档生成工具apipost

   一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...

8. vvv在线文档导出工具_使用ApiPost工具快速生成在线接口文档

   ApiPost是一个支持团队协作,并可直接生成文档的API调试.管理工具.它支持模拟POST.GET.PUT等常见请求,是后台接口开发者或前端.接口测试人员不可多得的工具 .使用者不仅可以利用apio ...

9. 接口文档管理工具showDoc

   随着互联网的发展,前后端分离已成为互联网项目开发的业界标准使用方式. 由此而产生的前端开发工程师和后端开发工程师的沟通效率问题. 推荐一个应此而生的文档管理工具---showdoc showdoc官网 ...

最新文章

1. 动态产生一个TextBox，并使输入的文本靠右对齐
2. 【STM32】FreeRTOS资源(持续更新)
3. jmeter获取mysql数据并作为请求参数使用
4. linux转发邮件,转发Linux服务器上的传入邮件？
5. 181027每日一句
6. submit常用快捷键
7. 7z解压crc错误_7-Zip - 常见问题解答（FAQ）
8. 线性规划（一）：基本概念
9. windows多网卡叠加网速
10. 利用tushare读取中国股市数据，并用绘制股票行情图形
11. 宏碁笔记本安装固态硬盘
12. 股票入门浅学20210721
13. 利用小米数据库查找手机归属地
14. ionic5中轮播图ion-slides、ion-slide的使用
15. mkv视频格式转换mp4格式
16. 学机器学习的基础课程
17. MacBook装低版本系统需要的系统包
18. 前端——IndexedDB
19. 【转】微信小游戏开发源码_教程_工具_资源最新集合
20. CSS3实现自适应的聊天气泡

热门文章

1. 一文搞懂Nginx限流(简单实现)
2. 武田通过与Moderna和日本政府合作，在日本扩大COVID-19疫苗供货
3. 阿里云人脸识别C#调用示例参考 1
4. DHCP | 计算机网络
5. 超越BERT、GPT------屏蔽序列到序列预训练MASS(原理篇)
6. 物联网-鸡舍项目总结
7. SQL——计算次日留存率
8. EZBOOT kernel not found DOS返回EZBOOT错误
9. 映泰G31计算机主板进入BIOS,映泰主板bios设置方法【图解】
10. 将List集合按长度切分