PHPackages                             apidoc/apidoc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. apidoc/apidoc

ActiveLibrary[API Development](/categories/api)

apidoc/apidoc
=============

Documentation for API

013.0k↑52.9%1JavaScript

Since Sep 26Pushed 11y ago1 watchersCompare

[ Source](https://github.com/williamweber2/apidoc)[ Packagist](https://packagist.org/packages/apidoc/apidoc)[ RSS](/packages/apidoc-apidoc/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

apiDoc 0.7.x
============

[](#apidoc-07x)

Generates a RESTful web API Documentation.

[![Build Status](https://camo.githubusercontent.com/9705258596ac06b9597923a273f8ae10fab11a592fc477e1dfd6363ce91f3692/68747470733a2f2f7472617669732d63692e6f72672f617069646f632f617069646f632e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/apidoc/apidoc)[![NPM version](https://camo.githubusercontent.com/2a6ee28470b0f1722856573749602594cb7eef3ef875ee6881b799703fef0b96/68747470733a2f2f62616467652e667572792e696f2f6a732f617069646f632e737667)](http://badge.fury.io/js/apidoc)

Documentation at [apidocjs.com](http://apidocjs.com).

[Example](http://apidocjs.com/example/) output.

Installation
------------

[](#installation)

`npm install apidoc -g`

Example
-------

[](#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
-------------------------------

[](#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-module)

[grunt-apidoc](https://github.com/apidoc/grunt-apidoc) `npm install grunt-apidoc`.

Changelog
---------

[](#changelog)

[CHANGELOG.md](https://github.com/apidoc/apidoc/blob/master/CHANGELOG.md)

Help
----

[](#help)

Please add [issues](https://github.com/apidoc/apidoc/issues) if you have a question or found a problem. Pull requests are welcome too!

A chat about apiDoc is on [Gitter](https://gitter.im/apidoc/talk).

[![Gitter chat](https://camo.githubusercontent.com/328355410c7bcc10ff45f87b804005b28db332ca8238041f9622513f320712f1/68747470733a2f2f6261646765732e6769747465722e696d2f617069646f632f74616c6b2e706e67)](https://gitter.im/apidoc/talk)

License
-------

[](#license)

Copyright (c) 2013-2014 inveris OHG

Author Peter Rottmann

Licensed under the MIT license.

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 75.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1415911?v=4)[William Weber Silva](/maintainers/williamweber2)[@williamweber2](https://github.com/williamweber2)

---

Top Contributors

[![rottmann](https://avatars.githubusercontent.com/u/381201?v=4)](https://github.com/rottmann "rottmann (127 commits)")[![CodersBrothers](https://avatars.githubusercontent.com/u/2166523?v=4)](https://github.com/CodersBrothers "CodersBrothers (29 commits)")[![antonfisher](https://avatars.githubusercontent.com/u/599352?v=4)](https://github.com/antonfisher "antonfisher (4 commits)")[![isRuslan](https://avatars.githubusercontent.com/u/2136166?v=4)](https://github.com/isRuslan "isRuslan (1 commits)")[![Limech](https://avatars.githubusercontent.com/u/6559441?v=4)](https://github.com/Limech "Limech (1 commits)")[![martinj](https://avatars.githubusercontent.com/u/194438?v=4)](https://github.com/martinj "martinj (1 commits)")[![MattiasFestin](https://avatars.githubusercontent.com/u/1441064?v=4)](https://github.com/MattiasFestin "MattiasFestin (1 commits)")[![nebulade](https://avatars.githubusercontent.com/u/646768?v=4)](https://github.com/nebulade "nebulade (1 commits)")[![skeggse](https://avatars.githubusercontent.com/u/1348991?v=4)](https://github.com/skeggse "skeggse (1 commits)")[![thomaschaaf](https://avatars.githubusercontent.com/u/893393?v=4)](https://github.com/thomaschaaf "thomaschaaf (1 commits)")[![blackeyedboy](https://avatars.githubusercontent.com/u/3263734?v=4)](https://github.com/blackeyedboy "blackeyedboy (1 commits)")[![brandonhamilton](https://avatars.githubusercontent.com/u/164646?v=4)](https://github.com/brandonhamilton "brandonhamilton (1 commits)")

### Embed Badge

![Health badge](/badges/apidoc-apidoc/health.svg)

```
[![Health](https://phpackages.com/badges/apidoc-apidoc/health.svg)](https://phpackages.com/packages/apidoc-apidoc)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)