Web API文档生成工具apidoc使用

apidoc可以根据代码注释生成web api文档，支持大部分主流语言，相对而言，web接口的注释维护起来更加方便，不需要额外再维护一份文档。
apidoc从注释生成静态html网页文档，不仅支持项目版本号，还支持api版本号。

官网：Inline Documentation for RESTful web APIs

环境安装（windows系统为例）

1. node环境 Node.js官网 （下载最新的node.js msi安装包即可，按提示安装成功后，打开cmd命令行）

node -v  回车
#出现版本号则说明node安装成功

Centos上安装nodejs

通过yum安装

yum install -y nodejs

安装成功后

[root@chengchi mango_server]# node -v
v6.14.2
[root@chengchi mango_server]# npm -v
3.10.10

# 如果安装完nodejs没有安装上npm命令，请通过yum安装npm
[root@chengchi mango_server]# yum install npm

2. 安装cnpm（淘宝镜像）

安装完msi版本的node，已经默认安装好npm工具。因为国外官方npm太慢，故使用淘宝cnpm（这是一个完整 npm 镜像，你可以用此代替官方版本(只读)，同步频率目前为 10分钟 一次以保证尽量与官方服务同步。）

# 安装cnpm淘宝镜像
npm install -g cnpm --registry=https://registry.npm.taobao.org

# cnpm -v 回车（查看是否安装成功）

3. 安装apidoc命令工具

cnpm install apidoc -g

好了到这里，我们的环境安装工作到此结束，大功告成，现在开始写我们的注释然后生成文档吧。

注释的书写规则 和 生成

apidoc命令：

apidoc -i D:\att\att_2017\Application\Check -o D:\att\att_2017\apidoc

Web API文档生成工具apidoc