什么是apidocapidoc是一个轻量级的在线REST接口文档生成系统，支持Java、C、C#、PHP、Javascript等多种主流语言。用户根据需求编写相关注释，即可生成可读性好、界面美观的在线接口文档。在这里了解更多快速入门安装依赖安装nodejshttps://nodejs.org/从官网下载.msi文件；测试是否安装成功npm-vnpminstallation。由于新版NodeJS已经集成了npm，所以之前也安装了npm。也可以使用cmd命令行输入“npm-v”来测试是否安装成功。如下图，出现版本提示，就OK了。安装apidoc使用npm安装npminstallapidoc-g安装速度与网速有关，最多1~2分钟，apidoc-v在C:\Users\admin\AppData\下可以查看安装后的版本信息漫游\npm\node_modules\apidoc可以看到如下文件apidoc配置，打开example文件夹apidoc.json作为配置文件，修改参数为自己的项目信息。{"name":"apidoc-example","version":"0.3.0","description":"apidoc示例项目","title":"自定义apiDoc浏览器标题","url":"https://api.github.com/v1","sampleUrl":"https://api.github.com/v1","header":{"title":"我自己的header标题","filename":"header.md"},"footer":{"title":"我自己的页脚标题","filename":"footer.md"},"template":{"withCompare":true,"withGenerator":true}}将apidoc.json复制到需要生成文档的目录下，然后根据文档说明进行代码注释/***@api{get}/sguoshan_api/Logon获取用户信息*@apiVersion1.0.0*@apiNameLogon*@apiGroupUser*@apiPermission所有注册用户*@apiPrivate*@apiDescription相比0.9.0，安全性提升**@apiParam{String}username用户名/邮箱/会员号*@apiParam{Number}password用户密码*@apiExample使用示例：*http://api.guoshanchina.com/sguoshan_api/Logon?username=911117&password=123456**@apiSuccess{Number}id用户ID。*@apiSuccess{Date}注册注册日期。*@apiSuccess{Date}name用户的全名。*@apiSuccess{String[]}nicknames用户昵称列表（字符串数组）。*@apiSuccess{Object}profile配置文件数据（对象示例）*@apiSuccess{Number}profile.age用户年龄。*@apiSuccess{String}profile.image头像图像。*@apiSuccess{Object[]}options用户选项列表（对象数组）。*@apiSuccess{String}options.name选项名称。*@apiSuccess{String}options.value选项值。**@apiSuccessExamplesuccessreturn():{"msg":"Gettingsuccess","status":"200","data":{"id":"123","name":"shmily"}}*@apiErrorNoAccessRight登录成功后才能访问。*@apiErrorUserNotFound用户id错误。*@apiErrorExamplefailedreturn():*HTTP/1.1401NotAuthenticated*{*"msg":"Nopermission","status":"401"*}*/functiongetUser(){return;}命令行切换到项目上层apidoc.json（api目录）d:cdwww/shop/Webapidoc-iapi/-oapidoc/运行后api同级目录即可足以看到生成apidoc的文件夹双击文件夹下的index.html可以看到文件。
