PHPackages                             rabblerouser/api-autodoc - 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. rabblerouser/api-autodoc

ActiveLibrary[API Development](/categories/api)

rabblerouser/api-autodoc
========================

An automatic API documentation creation utility.

0.1.3(10y ago)2422MITHTML

Since Sep 23Pushed 9y ago4 watchersCompare

[ Source](https://github.com/rabble-rouser/laravel-api-autodoc)[ Packagist](https://packagist.org/packages/rabblerouser/api-autodoc)[ Docs](http://rabbleandrouser.com)[ RSS](/packages/rabblerouser-api-autodoc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (2)Versions (12)Used By (0)

laravel-api-autodoc
===================

[](#laravel-api-autodoc)

An automatic api documentation generator for Laravel applications.

Quick Start
-----------

[](#quick-start)

### Installation

[](#installation)

#### Install Through Composer

[](#install-through-composer)

You can either add the package directly by firing this command

```
$ composer require rabblerouser/api-autodoc:*

```

\-- or --

Add in the `require` key of `composer.json` file manually

```
"rabblerouser/api-autodoc": "*"

```

And Run the Composer update command

```
$ composer update

```

#### Add Service Providers (Lumen)

[](#add-service-providers-lumen)

Add the following service providers to your `bootstrap/app.php` file.

```
$app->register(RabbleRouser\ApiAutoDoc\Providers\DocumentationServiceProvider::class);
$app->register('Irazasyed\Larasupport\Providers\ArtisanServiceProvider');
```

#### Add Service Providers (Laravel)

[](#add-service-providers-laravel)

Add the following service providers to your `config/app.php` file.

```
'providers' => [
    // Other Service Providers
        RabbleRouser\ApiAutoDoc\Providers\DocumentationServiceProvider::class,
        'Irazasyed\Larasupport\Providers\ArtisanServiceProvider'
],
```

#### Override Doc View Templates

[](#override-doc-view-templates)

If you want to override the default view templates, run the artisan `publish` command.

```
$ php artisan vendor:publish

```

This will create a vendor/api-autodoc/views/ directory in the `resources` directory of your Lumen/Laravel installation. Api AutoDoc will load those templates instead of its defaults.

Usage
-----

[](#usage)

In your application's `routes.php` file, add a `docCategory` parameter to the route array.

#### Example

[](#example)

```
    $app->get('some_resource', [
        'uses' => 'App\Http\Controllers\SomeResourceController@index',
        'docCategory' => 'Some Resource'
    ]);
```

You can see your autogenerated API documentation by going to the `/docs` page of your site.

#### Example

[](#example-1)

```
    http://api.mywebservice.com/docs

```

License
-------

[](#license)

[MIT](LICENSE) © [Rabble + Rouser](http://rabbleandrouser.com)

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 92.3% 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.

###  Release Activity

Cadence

Every ~10 days

Recently: every ~1 days

Total

11

Last Release

3787d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8cca11d87fc97660da253f8b4006eb3916271af67666f68dd503b242fc47709a?d=identicon)[chbeninati](/maintainers/chbeninati)

---

Top Contributors

[![chbeninati](https://avatars.githubusercontent.com/u/13068127?v=4)](https://github.com/chbeninati "chbeninati (12 commits)")[![cbeninati](https://avatars.githubusercontent.com/u/1027918?v=4)](https://github.com/cbeninati "cbeninati (1 commits)")

---

Tags

apidocumentationwebservice

### Embed Badge

![Health badge](/badges/rabblerouser-api-autodoc/health.svg)

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

###  Alternatives

[mpociot/laravel-apidoc-generator

Generate beautiful API documentation from your Laravel application

3.5k3.1M12](/packages/mpociot-laravel-apidoc-generator)[binarytorch/larecipe

Generate gorgeous recipes for your Laravel applications using MarkDown

2.5k2.7M16](/packages/binarytorch-larecipe)[ovac/idoc

Generate beautiful API documentation from your Laravel application

184477.6k2](/packages/ovac-idoc)[juststeveking/laravel-redoc

A simple API documentation package for Laravel using OpenAPI and Redoc

92289.9k1](/packages/juststeveking-laravel-redoc)[yaro/apidocs

Api documentation generator for Laravel 5

114.1k](/packages/yaro-apidocs)

PHPackages © 2026

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