一个高大上的东西API接口在线文档

一个高大上的东西API接口在线文档

最近在公司忙一个项目，接口人员没时间给API写注释，我也懒得催了，每次都催，只能靠自己了（小公司）况且，还有一个新来的同事要用到接口，本来用的是文本自己一个个写，突然昨天想了想，是不是有那种自动化接口文档。

Mashery API Management

一个Intel公司出品的玩意，Mashery is an intel company,其他信息百度啊，谷歌啊，应该就OK了。我英文烂渣渣只能看到大概意思，就不献丑了。

Git:Mashery

构建/运行时依赖关系(需要什么东西)

1. Nodejs -server-side Js 引擎
2. npm - nodeJs包管理和分发工具。
3. Redis - key + value数据库

注：我的电脑是MAC电脑，安装了Xcode.Node.js npm 已经安装 就一个Redis没有安装，其他系统请参考
Mashery官方文档。

关于Node,NPM REDIS 安装说明

1. Node.js - https://github.com/joyent/node/wiki/Installation
2. npm (Node package manager) - https://github.com/isaacs/npm
3. Redis - http://redis.io/download

关于自己

我的电脑上就一个Redis没有安装所以只有Redis的安装过程，虽然我也知道我的渣渣博客没几个人看。

Redis安装过程

下载Redis3.0版本
然后切换到你安装包redis-3.0.0.tar.gs目录，使用命令解压这个压缩包

tar xzf redis-3.0.0.tar.gz #解压
cd redis-3.0.0  #切换到这个目录
make            #执行文件

稍等一会，等待执行过程完毕。
执行完毕后，切换目录,执行文件

cd src
./redis-server #开启这个服务

就会出现下面这个玩意。

                _._                                                  
           _.-``__ ''-._                                             
      _.-``    `.  `_.  ''-._           Redis 3.0.0 (00000000/0) 64 bit
  .-`` .-```.  ```\/    _.,_ ''-._                                   
 (    '      ,       .-`  | `,    )     Running in standalone mode
 |`-._`-...-` __...-.``-._|'` _.-'|     Port: 6379
 |    `-._   `._    /     _.-'    |     PID: 6093
  `-._    `-._  `-./  _.-'    _.-'                                   
 |`-._`-._    `-.__.-'    _.-'_.-'|                                  
 |    `-._`-._        _.-'_.-'    |           http://redis.io        
  `-._    `-._`-.__.-'_.-'    _.-'                                   
 |`-._`-._    `-.__.-'    _.-'_.-'|                                  
 |    `-._`-._        _.-'_.-'    |                                  
  `-._    `-._`-.__.-'_.-'    _.-'                                   
      `-._    `-.__.-'    _.-'                                       
          `-._        _.-'                                           
              `-.__.-'                          

关于I/O DOCS安装说明

从命令行输入：

git clone http://github.com/mashery/iodocs.git #当然你要攸Git工具
cd iodocs
npm install

运行 I/O DOCS

创建你配置文件通过复制默认配置文件

cp config.json.sample config.json

关于配置文件，可以看看里面的一些参数说明，

开启I/O DOCS

npm start

在浏览器上输入：localhost:3000 可以访问你的I/O Docs

就是这个玩意了