开源的api文档管理系统

  • 在项目中,需要协同开发,所以会写许多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

5、postMan

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

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

docute 的文档: https://docute.js.org/#/zh-Hans/ (基于 Vue)

Github 项目:https://github.com/egoist/docute

7、SmartWiki 接口文档在线管理系统

8、SosoApi
SosoApi,编辑Swagger UI的神器

9、CrapApi开源接口管理系统演示地址

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

GitHub源码地址:https://github.com/EhsanTang/...
码云源码地址:http://git.oschina.net/CrapAp...

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

其他功能:项目管理、用户管理、模块管理、接口管理、接口版本管理、接口拷贝、接口文档pdf下载、接口mock、模块加密访问、
接口在线调试、数据字典管理、数据字典加密访问多管理员、多权限、多角色管理、自定义菜单、自定义网站样式、文档留言、
错误码管理、接口排序、DOC、PDF、TEXT、EXCEL等资源管理、支持版本号控制、文档内容检索、操作日志记录、
根据日志恢复数据、markdown编辑器、kindeditor编辑器、angularjs编辑器、Lucene搜索、项目成员管理...

站点使用地址:http://api2.crap.cn
效果图:

10、 TeaKKi
这个WIKI用来写文档也不错~
TeaKKi == team wiki, https://teakki.com 超越了wiki, 在wiki基础上支持团队知识协作

11、Web API文档生成工具apidoc

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

工具名称:apiDoc 
Git地址:https://github.com/apidoc/apidoc 
项目地址:http://apidocjs.com/ 
样例项目:http://apidocjs.com/example_b... 
apoDoc是从源码的注释中生成RestFul api 文档,样子还是蛮漂亮的……

使用apidoc 生成Restful web Api文档
NodeJS、NPM安装配置步骤(windows版本)

Apidoc安装与使用

具体步骤:

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

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>

12、PHP_DOC 实时生成 API 文档
https://segmentfault.com/a/11...

转载于 https://www.cnblogs.com/libaoli/p/8295835.html

API管理工具的更多相关文章

  1. FREE 开源 API 管理工具等

    最近学习API 管理工具,发现几个不错的东西,记录如下: 1.IBM 收购NODE 厂家  STRONGLOOP 有一产品LOOPBACK,开源,好! 2.apigee  api管理平台 也不错. 3 ...

  2. API 管理工具

    API 管理工具 你还苦于无法有效的管理大量的API吗?今天给大家介绍一款API的管理工具.这款工具可以免费使用,虽然中途可能会提示你购买,但并不影响我们的使用. 下载地址: Windows:http ...

  3. Api管理工具(spring-rest-docs)

    对于app开发来说,必须需要有相应的api文档,一般最基础的就是用markdown工具来撰写api文档.当对于开发人员来说,是总会想着寻找更方便撰写,测试,对接前端开发的文档生成的工具. 其实这方面的 ...

  4. 你不得不知的几款常用的在线API管理工具

    在项目开发过程中,总会涉及到接口文档的设计编写,之前使用的都是ms office工具,不够漂亮也不直观,变更频繁的话维护成本也更高,及时性也是大问题.基于这个背景,下面介绍几个常用的API管理工具,方 ...

  5. 几款常用的在线API管理工具(是时候抛弃office编写接口文档了)

    在项目开发过程中,总会涉及到接口文档的设计编写,之前使用的都是ms office工具,不够漂亮也不直观,变更频繁的话维护成本也更高,及时性也是大问题.基于这个背景,下面介绍几个常用的API管理工具,方 ...

  6. 介绍几款常用的在线API管理工具

    在项目开发过程中,总会涉及到接口文档的设计编写,之前使用的都是ms office工具,不够漂亮也不直观,变更频繁的话维护成本也更高,及时性也是大问题.基于这个背景,下面介绍几个常用的API管理工具,方 ...

  7. API管理工具介绍

    ​ 时间都去哪里了 敏捷迭代和团队协作,前后端分离的工作模式几乎是每个互联网公司的常规工作模式. 前后端分离,各自开发的优点很多,其中一项是它只需要提供一个统一的API接口,即可被web,iOS,An ...

  8. 论元数据和API管理工具

    公司里面的很多部门都在广泛的采用元数据管理,也采用了公司内部开发的元数据管理工具,有些部门的实施效果一直非常好,而有些部门的效果则差强人意.这个问题,其实和软件系统开发完成进入维护阶段后成本居高不下的 ...

  9. 前端api管理工具YApi

    使用YApi接口管理工具,提升前端开发效率前端开发苦恼: 代码中使用json数据模拟后端api数据,注释调取api接口代码,代码乱七八糟 为了测试不同case,央求后端人员返回不同的数据,返回状态.返 ...

随机推荐

  1. l2-002 链表去重 (未解决)

    L2-002. 链表去重 时间限制 300 ms 内存限制 65536 kB 代码长度限制 8000 B 判题程序 Standard 作者 陈越 给定一个带整数键值的单链表L,本题要求你编写程序,删除 ...

  2. Leetcode(94)-二叉树的中序遍历

    给定一个二叉树,返回它的中序 遍历. 示例: 输入: [1,null,2,3] 1 \ 2 / 3 输出: [1,3,2] 思路:和上篇的前序遍历一样,同样有递归和非递归的做法 (1)递归 vecto ...

  3. u-boot 移植 --->4、Tiny210核心板的DDR初始化下详解

    RAM的原理简单学习 DDR是RAM的一种,RAM常见的类型有SRAM,SDRAM,DDR他们的共同特点是,随机存储意味着读写速度快,掉电后数据丢失,所以常用来存储程序中的变量. SRAM 静态随机存 ...

  4. 硬盘测试工具fio用法总结

    一  fio介绍 linux下的一种常用的磁盘测试工具,支持裸盘和文件形式进行测试   二  硬盘测试常用名词 延迟:io的发起到返回写入成功的时间成为延迟,fio中延迟分为lat,slat,clat ...

  5. js 检测屏幕分辨率

    js 检测屏幕分辨率 class screenChecker { constructor() { this.screen = window.screen; this.fullscreen = fals ...

  6. LeetCode 算法题解 js 版 (001 Two Sum)

    LeetCode 算法题解 js 版 (001 Two Sum) 两数之和 https://leetcode.com/problems/two-sum/submissions/ https://lee ...

  7. Chrome V8 引擎源码剖析

    Chrome V8 引擎源码剖析 V8 https://github.com/v8/v8 array & sort https://github.com/v8/v8/search?l=Java ...

  8. AirPods 2 声音非常小

    AirPods 2 声音非常小 bug 停用蓝牙绝对音量 可能是因为开启了耳机的绝对音量功能; 绝对音量功能开启后,耳机的音量和手机音量分开, 可以在手机设置里停用绝对音量; refs http:// ...

  9. write a node cli tools, step by step

    write a node cli tools, step by step how to write a node cli tools node cli tools, step by step, nod ...

  10. nasm astrrchr函数 x86

    xxx.asm %define p1 ebp+8 %define p2 ebp+12 %define p3 ebp+16 section .text global dllmain export ast ...