PHPackages                             axeldotdev/laravel-api-doc - 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. axeldotdev/laravel-api-doc

ActiveLibrary[API Development](/categories/api)

axeldotdev/laravel-api-doc
==========================

This package help you build your REST API documentation.

v0.1.11(4y ago)220[3 PRs](https://github.com/axeldotdev/laravel-api-doc/pulls)MITPHPPHP ^8.1

Since May 17Pushed 2y ago1 watchersCompare

[ Source](https://github.com/axeldotdev/laravel-api-doc)[ Packagist](https://packagist.org/packages/axeldotdev/laravel-api-doc)[ Docs](https://github.com/axeldotdev/laravel-api-doc)[ GitHub Sponsors](https://github.com/axeldotdev)[ RSS](/packages/axeldotdev-laravel-api-doc/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (2)Dependencies (14)Versions (16)Used By (0)

Laravel API Doc
===============

[](#laravel-api-doc)

[![Latest Version on Packagist](https://camo.githubusercontent.com/93504195e45100ace8a6f96740850c2df5a203b3f479171ad8a74dc5a9ef352e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6178656c646f746465762f6c61726176656c2d6170692d646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/axeldotdev/laravel-api-doc)[![GitHub Tests Action Status](https://camo.githubusercontent.com/3a59385d89e2c69441c3a438955075eacbc5d8a81f3bf6c6cf9ba8ebb2b10141/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f6178656c646f746465762f6c61726176656c2d6170692d646f632f72756e2d74657374733f6c6162656c3d7465737473)](https://github.com/axeldotdev/laravel-api-doc/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/c2622afbb9889692650ac7a8fa67627e8d674d26df7ae228d125807466f359d4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f6178656c646f746465762f6c61726176656c2d6170692d646f632f436865636b253230262532306669782532307374796c696e673f6c6162656c3d636f64652532307374796c65)](https://github.com/axeldotdev/laravel-api-doc/actions?query=workflow%3A%22Check+%26+fix+styling%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/38b403d2104310727f51327476e90a119b5732575d982c9654c5f8df5eb42ce5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6178656c646f746465762f6c61726176656c2d6170692d646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/axeldotdev/laravel-api-doc)

This package help you build your REST API documentation.

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

[](#installation)

You can install the package via composer:

```
composer require axeldotdev/laravel-api-doc
```

You can publish the config file with:

```
php artisan vendor:publish --tag="laravel-api-doc-config"
```

Optionally, you can publish the views using

```
php artisan vendor:publish --tag="laravel-api-doc-views"
```

Features
--------

[](#features)

- Customizable get started view
- Customizable authentication view
- Customizable errors view
- Auto-generated routes views via API routes, controllers, requests, etc.
- Customizable routes views
- Versions manager
- Copy code examples into the clipboard

Coming soon :

- Fields and params example values, enums values, etc.
- Code examples in Curl, PHP and Javascript
- Static generator into a HTML file

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Axel Charpentier](https://github.com/axeldotdev)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

26

—

LowBetter than 41% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% 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 ~0 days

Total

12

Last Release

1507d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/10605697?v=4)[Axel Charpentier](/maintainers/axeldotdev)[@axeldotdev](https://github.com/axeldotdev)

---

Top Contributors

[![axeldotdev](https://avatars.githubusercontent.com/u/10605697?v=4)](https://github.com/axeldotdev "axeldotdev (16 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (8 commits)")

---

Tags

apidocslaravelphplaravelaxeldotdevlaravel-api-doc

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/axeldotdev-laravel-api-doc/health.svg)

```
[![Health](https://phpackages.com/badges/axeldotdev-laravel-api-doc/health.svg)](https://phpackages.com/packages/axeldotdev-laravel-api-doc)
```

###  Alternatives

[dedoc/scramble

Automatic generation of API documentation for Laravel applications.

2.1k11.2M100](/packages/dedoc-scramble)[spatie/laravel-pdf

Create PDFs in Laravel apps

1.0k4.8M47](/packages/spatie-laravel-pdf)[defstudio/telegraph

A laravel facade to interact with Telegram Bots

816333.6k3](/packages/defstudio-telegraph)[rawilk/profile-filament-plugin

Profile &amp; MFA starter kit for filament.

3914.6k](/packages/rawilk-profile-filament-plugin)[simplestats-io/laravel-client

Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof.

5021.9k](/packages/simplestats-io-laravel-client)[lettermint/lettermint-laravel

Official Lettermint driver for Laravel

1190.2k1](/packages/lettermint-lettermint-laravel)

PHPackages © 2026

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