forked fromc0b41/gulp-apidoc
- Notifications
You must be signed in to change notification settings - Fork1
techgaun/gulp-apidoc
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
gulp-apidoc
Generates a RESTful web API Documentation.Documentation atapidocjs.com
Uses theapidoc library.
Is a fork of original gulp-apidoc because this was very urgent
/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. */
Install withnpm
npm install --save-dev gapidocvargulp=require('gulp'),apidoc=require('gapidoc');gulp.task('apidoc',function(){apidoc.exec({src:"example/",dest:"build/"});});
With options:
vargulp=require('gulp'),apidoc=require('gapidoc');gulp.task('apidoc',function(){apidoc.exec({src:"example/",dest:"build/",debug:true,includeFilters:[".*\\.js$"]});});
Other optionscheckout.
Type:String
Type:stringDefault:doc/
Type:BooleanDefault:false
Type:BooleanDefault:true
Type:ArrayDefault:[]