-
gulp-apidoc是一款用于生成RESTful Web API文档的工具
资源介绍
不再支持此软件包,请改用
-apidoc
使用库生成RESTful Web API文档。
这个怎么运作
/path/api/stuff.js :
/**
* @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.
*/
安装
用安装
npm install --save-dev gulp-apidoc
用法
var gulp = require ( 'gulp' ) ,
apidoc = require ( 'gulp-apidoc' ) ;
gulp . task ( 'apidoc' , function ( done ) {