RESTful web API Documentation Generator
JavaScript
Pull request Compare This branch is 8 commits ahead, 32 commits behind c0b41:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
.gitignore
.travis.yml
gulpfile.js
index.js
package.json
readme.md

readme.md

gulp-apidoc Build Status

Generates a RESTful web API Documentation. Documentation at apidocjs.com

Uses the apidoc library.

Is a fork of original gulp-apidoc because this was very urgent

How It Works

/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

Install with npm

npm install --save-dev gapidoc

Usage

var gulp = require('gulp'),
    apidoc = require('gapidoc');

gulp.task('apidoc', function(){
          apidoc.exec({
            src: "example/",
            dest: "build/"
          });
});

With options:

var gulp = require('gulp'),
    apidoc = require('gapidoc');

gulp.task('apidoc',function(){
              apidoc.exec({
                  src: "example/",
                  dest: "build/",
                  debug: true,
                  includeFilters: [ ".*\\.js$" ]
              });
});

Other options checkout.

API

apidoc(options)

options.src

Type: String

options.dest

Type: string Default: doc/

options.debug

Type: Boolean Default: false

options.log

Type: Boolean Default: true

options.includeFilters

Type: Array Default: []