PHPackages                             owowagency/automated-api-docs - 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. owowagency/automated-api-docs

ActiveLibrary[API Development](/categories/api)

owowagency/automated-api-docs
=============================

Automated API docs in OWOW style.

0.3.6(5y ago)03.9k2[1 issues](https://github.com/owowagency/automated-api-docs/issues)[1 PRs](https://github.com/owowagency/automated-api-docs/pulls)MITPHPPHP ^7.0CI failing

Since Mar 27Pushed 4y ago1 watchersCompare

[ Source](https://github.com/owowagency/automated-api-docs)[ Packagist](https://packagist.org/packages/owowagency/automated-api-docs)[ RSS](/packages/owowagency-automated-api-docs/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (3)Versions (13)Used By (0)

Auto generated documentation for APIs
=====================================

[](#auto-generated-documentation-for-apis)

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

[](#installation)

Installation and setup time is estimated to be around 5 to 10 minutes. Install this package via composer.

```
composer require owowagency/automated-api-docs
```

If you're using Laravel >= 5.5 this package will automatically be added to your providers list. If using a lower version, add the service provider to the `providers` array in `config/app.php`.

```
OwowAgency\AutomatedApiDocs\ServiceProvider::class,
```

You're now ready for setup.

The package comes with a config file. The default config should be good in most use cases. However, feel free to change it. To publish the config file run the following command

```
php artisan vendor:publish --provider="OwowAgency\AutomatedApiDocs\ServiceProvider" --tag="config"
```

Setup
-----

[](#setup)

After installation, and optionally configuration, we need to setup the package. The package usage a hook in the HTTP calls to your app via the feature tests to monitor all requests and responses.

Firstly, you need to use the trait to enable to monitor hook.

```
use OwowAgency\AutomatedApiDocs\DocsGenerator;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication, DocsGenerator;
}
```

Secondly, you need to register a shutdown function so that the package now when to parse the docs into a custom format which is readable for the parsers.

```
protected function setUp(): void
{
    parent::setUp();

    $config = config('automated-api-docs');

    register_shutdown_function(function () use ($config) {
        $this->exportDocsToJson($config);
    });
}
```

Next, you need to add [this file](https://github.com/owowagency/automated-api-docs/blob/master/src/Envoy.blade.php) to the root of your Laravel application. If this file already exists in your app you probably only need to copy the `documentation` task.

Finally, make sure to add the following command `envoy run documentation` in your deployment script. For example on [Laravel Forge](https://forge.laravel.com).

You're now ready to register all the monitor hooks. You can do that by calling the `monitor()` method before calling a route.

```
public function test_foo()
{
    $user = factory(User::class)->create();

    $this->actingAs($user)->monitor()->post('/v1/posts', [
        'title' => 'Foo bar',
    ]);
}
```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 54.5% 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 ~53 days

Recently: every ~78 days

Total

11

Last Release

2067d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2b0064d818f9593dfb4f9d86217bbf5f14961ad6779b84fd5546dd91f296d898?d=identicon)[dees040](/maintainers/dees040)

---

Top Contributors

[![dees040](https://avatars.githubusercontent.com/u/5390555?v=4)](https://github.com/dees040 "dees040 (12 commits)")[![thomasowow](https://avatars.githubusercontent.com/u/45201651?v=4)](https://github.com/thomasowow "thomasowow (7 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (2 commits)")[![YouneselBarnoussi](https://avatars.githubusercontent.com/u/16510310?v=4)](https://github.com/YouneselBarnoussi "YouneselBarnoussi (1 commits)")

---

Tags

apilaravelautomateddocs

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/owowagency-automated-api-docs/health.svg)

```
[![Health](https://phpackages.com/badges/owowagency-automated-api-docs/health.svg)](https://phpackages.com/packages/owowagency-automated-api-docs)
```

###  Alternatives

[binarytorch/larecipe

Generate gorgeous recipes for your Laravel applications using MarkDown

2.5k2.7M16](/packages/binarytorch-larecipe)[dingo/blueprint

API Blueprint documentation generator.

2707.8M22](/packages/dingo-blueprint)[yaro/apidocs

Api documentation generator for Laravel 5

114.1k](/packages/yaro-apidocs)

PHPackages © 2026

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