apidoc

apiDoc 0.10.x

Generates a RESTful web API Documentation.

Changes from previous version visit CHANGELOG.md

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.

Editor integration

• Eclipse plugin
• Sublime Text plugin

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.

Changelog

0.10.0

• Split apidoc code

  • apidoc is now only the CLI-Tool with UI-Template and file creation (as you know it). You can use apidoc without change anything.

  • apidoc-core (for developers) is the parser and response the api-data.

  • apidoc-example (for developers) are the test files for the apidoc-spec.

• CLI

  • Replace optimist (not maintained anymore) with nomnom: true / false parameters can now be used, e.g. enable markdown (default) --markdown or disable --no-markdown.
  • Add parameter --markdown.
  • Replace the custom Logger with winston.

• Parser

  • Bugfix: Settings to enable / disable markdown (marked-gfm was previously used).

• Template

  • Add generator.url and generator.name to the footer generator information (for custom ui-generators).
  • Move handlebars_helper.js to utils/

• Common

  • Remove grunt dependencies (test run with npm run test).
  • Change grunt-apidoc (0.10.0) to use always the latest version of apiDoc.