Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
RESTful web API Documentation Generator.
JavaScript HTML CSS
branch: master

Merge pull request #261 from tomlelievre/spelling-mistake-fr

Spelling mistake in the french translation file
latest commit 2c98556781
@rottmann rottmann authored

README.md

apiDoc

Generates a RESTful web API Documentation.

Build Status Dependency Status NPM version

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

Grunt Module

grunt-apidoc npm install grunt-apidoc.

Gulp Module

gulp-apidoc npm install gulp-apidoc.

Editor integration

Converter

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.

Gitter chat

Something went wrong with that request. Please try again.