脚本宝典收集整理的这篇文章主要介绍了ApiDoc + github page 使用，脚本宝典觉得挺不错的，现在分享给大家，也给大家做个参考。

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *  * @apiParam {Number} id Users unique ID.
 *  * @apiSuccess {String} Firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */@H_406_36@
这里面的这些注解都是ApiDoc定义好的，你只要按照官方文档使用就好了。ApiDoc 官网

3. 开始搞起来
安装

      

      
      
      
      
npm install apidoc -g
运行

      

      
      
      
      
apidoc -i api/ -o docs/
api是你的代码目录也就是你使用注释的文件目录，它会自动扫描使用注解的文件。docs文件时你要生成api文档的目录，也是gIThub page最后要使用的目录。
检查api文档
在docs目录下直接打开index.htML就可以查看最终结果了。

4. github page
github page 是一项免费的web服务，它允许你把你的静态页面发布出去共其他用户通过浏览器查看。刚才我们生成的文档内容都在我们本地，现在我们需要把它发布到github上

创建github仓库
将自己的生成后的戴阿曼上船，就是docs整个目录
在仓库的 setting中开启page服务
用page提供的url去访问

总结
ApiDoc提供了更好的api文档阅读体验，对于开发者来说免去了写文档的麻烦。不过不足就是不能像swagger那样提供在线调试，而且要想描述一个api需要些很多的注释。
脚本宝典总结
       
以上是脚本宝典为你收集整理的ApiDoc + github page 使用全部内容，希望文章能够帮你解决ApiDoc + github page 使用所遇到的问题。
		
如果觉得脚本宝典网站内容还不错，欢迎将脚本宝典推荐好友。
		
本图文内容来源于网友网络收集整理提供，作为学习参考使用，版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ：384754419，请注明来意。