apidoc

apiDoc 0.7.x

Generates a RESTful web API Documentation.

Important markdown for all description fields is now enabled!

Documentation at apidocjs.com.

Example output.

Installation

npm install apidoc -g

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

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.

Changelog

CHANGELOG.md

License

Copyright (c) 2013-2014 inveris OHG Author Peter Rottmann [e-mail] Licensed under the MIT license.

Changelog

0.7.1

• Add type for @apiExample {type} Title, @apiSuccessExample, @apiErrorExample.
• Add type switch in template.
• Append filetype to fields at ajax reuqest testform.
• Bugfix: Same file handling with regexp under win32. (https://github.com/apidoc/apidoc/issues/109)