restful api文档生成器--神器

我现在还不是很懂到底什么才是restful api，目前理解的大概就是：一种接口，只管拿参数进来，做一系列处理，返回json字符串形式的结果。而restful api风格的api文档，就是用来说明这个接口需要传进什么参数，每个参数是什么含义，有什么要求，经过处理之后，该接口返回了什么内容，每一个数据代表什么意思。另外该工具还提供许多可直接使用的设置参数，可在页面生成示例等。

http://apidocjs.com/ 这个是官网，以现在的能力还不能只看官网就搞定。所以借助雷锋们的博客 http://www.jianshu.com/p/e3a04b5d8bb4# 这个虽然是拿的mac做测试，但是基本步骤是差不多的。需要注意的是先要安装nodeJs的环境（虽然我也不晓得是个什么鬼，大概就是要用那个npm工具去安装apidoc）http://www.runoob.com/nodejs/nodejs-install-setup.html 接下来还参考了这个博客http://www.ithao123.cn/content-5717726.html

先拿在官网下的template测一下比较靠谱~

然后可以看看官网那些个例子，所有以@api开头的参数是什么意思，如何设置，生成的效果是什么样子。

对了，生成doc必须的两个文件apidoc.json(或者package.doc)和写好了注释的源文件。

准备好了这两样，开cmd，进入放文件的目录，打上apidoc回车。有更多高大尚的生成指令，参见官网。

这个神器生成出的效果别提多好了。把bak文件放在一起就会生成在同一个doc中。