Skip to content

i-a-m/apidoc

This branch is 440 commits behind apidoc/apidoc:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ae65281 · May 19, 2017
Mar 13, 2017
Jan 16, 2017
Sep 19, 2016
May 19, 2017
Jan 13, 2017
Mar 15, 2017
May 8, 2015
Dec 18, 2014
Jan 23, 2017
May 19, 2017
Jan 23, 2017
Mar 15, 2017
Nov 17, 2014
Jan 13, 2017
May 8, 2015
May 19, 2017
May 19, 2017

Repository files navigation

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 or as Docset.

Example output.

HELP NEEDED! Search for a Developer

Because of my limited time i need one or more devs that could build and maintain a "Send Sample Request Plugin".

The Plugin should be loose coupled to the template, so it should be a separate project. This Plugin should send example data to an API-Endpoint and process the response. Supported formats should be JSON, XML, whatever.

Many issues belong to the current (unmaintained) plugin, (Milestone: Send Sample Request Plugin)(https://github.com/apidoc/apidoc/milestone/4) If you want ot work on this, please send me a PM.

Installation

$ npm install apidoc -g

Alternative docker install

$ docker pull apidoc/apidoc

Then you will need to mount your file storage -v '<apidoc.json dir>:/apidoc' to docker container.

Example:

$ docker run --rm -v '$(PWD):/apidoc' -it apidoc/apidoc \
    --input ./example \
    --output ./docker-example \
    -v

Creates from input files in example/ a documentation in path docker-example/.

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

Plugins (extend apiDoc)

apiDoc will auto include installed plugins.

  • apidoc-plugin-schema Generates and inject apidoc elements from api schemas. npm install apidoc-plugin-schema

Build tools

Integration

Converter

FAQ

Extend apiDoc and write your own Plugin

For details and an example view apidoc-plugin-test

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

About

RESTful web API Documentation Generator.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 72.0%
  • HTML 20.4%
  • CSS 7.6%