apidoc

apiDoc

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, Scala (all DocStyle capable languages):

  /**
    * This is a comment.
    */
  

• Clojure:

  ;;;;
  ;; 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
  

Build tools

• flask-apidoc pip install flask-apidoc
• grunt-apidoc npm install grunt-apidoc.
• gulp-apidoc npm install gulp-apidoc.

Editor integration

• Eclipse plugin
• Sublime Text plugin

Converter

• apidoc-swagger
• gulp-apidoc-swagger

FAQ

• Filter for public / private API

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

• Parser
  • Remove p-Tags from type-Field.
  • Update dependencies.
  • Update fixtures (type-Fields and line endings).