PHPackages                             yaro/apidocs - 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. yaro/apidocs

ActiveLibrary[API Development](/categories/api)

yaro/apidocs
============

Api documentation generator for Laravel 5

0.5.0(6y ago)104.1k4MITHTML

Since Jul 10Pushed 6y ago1 watchersCompare

[ Source](https://github.com/Cherry-Pie/ApiDocs)[ Packagist](https://packagist.org/packages/yaro/apidocs)[ RSS](/packages/yaro-apidocs/feed)WikiDiscussions master Synced yesterday

READMEChangelog (10)Dependencies (1)Versions (28)Used By (0)

ApiDocs Generator
=================

[](#apidocs-generator)

[![Scrutinizer Code Quality](https://camo.githubusercontent.com/2700c7000e6107c4f645f3557c886ca4dc3d492765b9ee15bfb3b6d96e236b4d/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4368657272792d5069652f417069446f63732f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/Cherry-Pie/ApiDocs/?branch=master)[![Build Status](https://camo.githubusercontent.com/9733642206db6591a44296f745b8457b116d8005bb105c0c8383ac5ce603703a/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4368657272792d5069652f417069446f63732f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/Cherry-Pie/ApiDocs/build-status/master)

L5 API Documentation generator based upon DocBlock comments.

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

[](#installation)

You can install the package through Composer:

```
composer require yaro/apidocs
```

Add this service provider and alias to `config/app.php`:

```
'providers' => [
    //...
    Yaro\ApiDocs\ServiceProvider::class,
    //...
]

'aliases' => [
    //...
    'ApiDocs' => Yaro\ApiDocs\Facade::class,
    //...
]
```

Then publish the config and assets files:

```
php artisan vendor:publish --provider="Yaro\ApiDocs\ServiceProvider"
```

And you should add a disk named snapshots to `config/filesystems.php` on which the [blueprint](https://apiblueprint.org) snapshots will be saved:

```
//...
'disks' => [
    //...
    'apidocs' => [
        'driver' => 'local',
        'root'   => storage_path('apidocs'),
    ],
//...
```

Usage
-----

[](#usage)

All your routes must begin with some segment, e.g. `/api/` (changed in config). Package will collect routes, that starts with this segment only.

Add to your route method DocBlock comment. e.g.:

```
/**
 * Some api endpoint for important stuff.
 *
 * Just show some template with
 * some very long description
 * on several lines
 *
 * @param int    $offset   Just an offset size
 * @param string $password
 */
public function getSomeStuff()
{
    return response()->json([]);
}
```

And create route to view your documentation.

```
Route::get('/docs', function() {
    return ApiDocs::show();
});
```

Also you can force authorization prompt by adding `apidocs.auth.basic` middleware. Authorized identites placed under `apidocs.auth.credentials` config.

```
Route::get('/docs', function() {
    return ApiDocs::show();
})->middleware(['apidocs.auth.basic']);
```

To exclude some routes/classes add them to config's `exclude`. Asterisks may be used to indicate wildcards.

```
'exclude' => [
    'classes' => [
        // 'App\Http\Controllers\*' - exclude all controllers from docs.
        // 'App\Http\Controllers\MyController@*' - remove all methods for specific controller from docs.
    ],

    'routes' => [
        // 'payment/test',
        // 'simulate/*',
    ],
 ],
```

Additionally you can create [API Blueprint](https://apiblueprint.org) file:

```
ApiDocs::blueprint()->create();
// or pass snapshot name and/or filesystem disc name
ApiDocs::blueprint()->create('my-newest-snapshot', 's3-blueprint');
```

Or just render its contents without creating file:

```
echo ApiDocs::blueprint()->render();
```

Or via `artisan`:

```
php artisan apidocs:blueprint-create
```

TODO
----

[](#todo)

- generate plain html page with all documentation info.
- fullsize block with response.

License
-------

[](#license)

The MIT License (MIT). Please see [LICENSE](https://github.com/Cherry-Pie/ApiDocs/blob/master/LICENSE) for more information.

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 97.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 ~41 days

Recently: every ~195 days

Total

26

Last Release

2242d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/337e05205184d845261f639b74255dedc7c3e75f069a38e79aa8083e91cf5a90?d=identicon)[Cherry Pie](/maintainers/Cherry%20Pie)

---

Top Contributors

[![Cherry-Pie](https://avatars.githubusercontent.com/u/3027596?v=4)](https://github.com/Cherry-Pie "Cherry-Pie (36 commits)")[![iMokhles](https://avatars.githubusercontent.com/u/1247248?v=4)](https://github.com/iMokhles "iMokhles (1 commits)")

---

Tags

apiapidocsdocumentationlaravellaravel-5-packageapilaraveldocumentationdocsblueprintAPI Blueprint

### Embed Badge

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

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

###  Alternatives

[binarytorch/larecipe

Generate gorgeous recipes for your Laravel applications using MarkDown

2.5k2.8M17](/packages/binarytorch-larecipe)[dingo/blueprint

API Blueprint documentation generator.

2707.8M22](/packages/dingo-blueprint)

PHPackages © 2026

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