apidoc

apiDoc 0.8.x

Generates a RESTful web API Documentation.

apiDoc creates a documentation from API descriptions in your source code.

Documentation at apidocjs.com.

Example output.

Installation

npm install apidoc -g

Changelog

CHANGELOG.md

Example

/**
 * @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.
 */

apidoc -i example/ -o doc/

Creates from input files in example/ a documentation in path doc/.

More examples and best practice hints: EXAMPLES.md

Supported programming languages

• C#, Go, Dart, Java, JavaScript, PHP (all DocStyle capable languages):

  /**
    * This is a comment.
    */
  

• CoffeeScript:

  ###
  This is a comment.
  ###
  

• Erlang:

  %{
  This is a comment.
  %}
  

• Perl

  #**
  # This is a comment.
  #*
  

  =pod
  This is a comment.
  =cut
  

• Python

  """
  This is a comment.
  """
  

• Ruby

  =begin
  This is a comment.
  =end
  

Grunt Module

grunt-apidoc npm install grunt-apidoc.

Help

Please add issues if you have a question or found a problem. Pull requests are welcome too!

A chat about apiDoc is on Gitter.

License

Copyright (c) 2013-2014 inveris OHG

Author Peter Rottmann [e-mail]

Licensed under the MIT license.

Changelog

0.8.0

• Parameter

  • Add as replacement for all (now) deprecated define and structure methods:

    • @apiDefine
    • @apiUse

  • Deprecated:

    • @apiDefineErrorStructure
    • @apiDefineHeaderStructure
    • @apiDefinePermission
    • @apiDefineStructure
    • @apiDefineSuccessStructure
    • apiErrorTitle
    • apiErrorStructure
    • apiHeaderStructure
    • apiHeaderTitle
    • apiParamTitle
    • apiStructure
    • apiSuccessTitle
    • apiSuccessStructure

  • Remove unneeded methods since success and error response can be grouped:

    • @apiInfo
    • @apiInfoExample
    • @apiInfoTitle

  • Add for consistent usage:

    • @apiHeaderExample
    • @apiParamExample

  • Change:

    • @apiPermission, multiple permission usage in a block is allowed now. Permission names must be defined with @apiDefine.

  • Extend:

    • @apiParam with size and allowed values.

• CLI

  • Show deprecated message. Show details with --debug or --verbose.
  • Improved error output.
  • Turn off verbose output by default.
  • Add debug output.

• Parser

  • Ignore other doc-language @-parameters (enables jsdoc, phpdoc, ... again).
  • Add apidoc specification version to project file.
  • Correctly handle Erlang comments.
  • Bugfix: Markdown error on Empty description.
  • Revised worker preProcess / postProcess functions.
  • Change parser export names.

• Template

  • Show size and allowed values in field description.
  • Change template sample request to handle custom named groups.
  • Update template vendor files (handlebars 2, requirejs)
  • Added support for using path-to-regexp in sample request.
  • Add jQueryAjaxSetup to apidoc.json for setup ajax requests (http://apidocjs.com/#configuration-template-settings).
  • Hide the ul for tabs if no content.