写在前面：你的代码一定要用API注解，否则一顿操作猛如虎，导出就得犯迷糊，因为你导出了一个寂寞。
废话不多说，直接上操作步骤：
1、以windows系统为例，首先电脑上安装node环境
1. node环境 #Node.js官网 （下载最新的node.js msi安装包即可，按提示安装成功后，打开cmd命令行）
node -v 回车
#出现版本号则说明node安装成功
2、如果安装完nodejs没有安装上npm命令，请通过yum安装npm
yum install npm
3、 安装cnpm（淘宝镜像）---可选项，也可不安装
安装完msi版本的node，已经默认安装好npm工具。因为国外官方npm太慢，故使用淘宝cnpm（这是一个完整 npm 镜像，你可以用此代替官方版本(只读)，同步频率目前为 10分钟 一次以保证尽量与官方服务同步。）
# 安装cnpm淘宝镜像
npm install -g cnpm --registry=https://registry.npm.taobao.org
# cnpm -v 回车（查看是否安装成功）
4、安装apidoc命令工具
cnpm install apidoc -g， 如果没有安装淘宝镜像，则使用命令 npm install apidoc -g
当然你也可以不全局安装，只在需要导入apidoc文档的目录里安装。
好了到这里，我们的环境安装工作到此结束。
5、下面可以导出你代码的api文档了
apidoc -i 代码所在目录 -o apidoc文档的输出存储目录
6、导出的文档结构图
apidoc文档.png
一个静态的文档很漂亮的生成了，但是实际控制这个方法的是api_data.js和api_project.js。但是实际上的数据显示是由api_data.json和api_project.json这两个 json 文件。
7、打开Eolikner系统，选择项目，在项目中导入apidoc
导入apidoc.png
8、选择api_data.json文件，点击确认等待导入即可。
至此就把本地代码生成了apidoc文档，又导入了Eolikner管理平台上，就可以在平台上进行接口测试了。
写在后面：api模板的注解参数，供参考
@api {post} /v1/auth/register User Register *
@apiName UserRegister *
@apiGroup userAuthentication * *
@apiParam {String} username New user's username. *
@apiParam {String} password New user's password. * *
@apiSuccess {String} username The username of the register user. *
@apiSuccess {string} message The registering success info. * *
@apiSuccessExample Success-Response: * HTTP/1.1 200 OK * { * "username": "username", * "message": "User registered successful" * } * *
@apiError REGISTER_FAILURE The register failure. * *
@apiErrorExample Error-Response: * HTTP/1.1 500 Internal Server Error * { * "err": "REGISTER_FAILURE", * "message": "User register failure!" * }
网友评论