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

ActiveLibrary[API Development](/categories/api)

php-nl/laravel-api-doc
======================

Highly configurable Laravel API documentation generator

03↑2900%PHP

Since Mar 24Pushed todayCompare

[ Source](https://github.com/Php-nl/laravel-api-docs)[ Packagist](https://packagist.org/packages/php-nl/laravel-api-doc)[ RSS](/packages/php-nl-laravel-api-doc/feed)WikiDiscussions main Synced today

READMEChangelog (1)DependenciesVersions (1)Used By (0)

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

[](#laravel-api-doc)

 A highly configurable, beautiful, and interactive API documentation generator for Laravel.

 [![Latest Version on Packagist](https://camo.githubusercontent.com/d7dd217c6e84d6b39a3b0e4d6da43b5d796b7ce5a301918eb512217401d55373/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7068702d6e6c2f6c61726176656c2d6170692d646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/php-nl/laravel-api-doc) [![PHP from Packagist](https://camo.githubusercontent.com/6fa97e5225b0b3c025c4fefbcfadc6f2f96de2ddc3102b7aa96a41dccc9d7280/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f7068702d6e6c2f6c61726176656c2d6170692d646f632e7376673f7374796c653d666c61742d737175617265)](https://php.net) [![Total Downloads](https://camo.githubusercontent.com/6548d23b8097cc3025d101f32c849efb1f52960fc0a4f183c04a9a1e29377e8a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7068702d6e6c2f6c61726176656c2d6170692d646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/php-nl/laravel-api-doc) [![License](https://camo.githubusercontent.com/e1fa77b152972a290bfd8fcd89968df473e2365f020f03535516e239cfa7091f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f7068702d6e6c2f6c61726176656c2d6170692d646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/php-nl/laravel-api-doc)

---

**Laravel API Doc** is an elegant, zero-configuration API documentation package designed to give your Laravel projects a beautiful, Stoplight Elements-inspired interactive dashboard out of the box.

It automatically parses your routes, form requests, and parameters to generate a live, testable documentation portal where you and your team can try out endpoints seamlessly.

✨ Features
----------

[](#-features)

- **Beautiful UI:** A premium, fully responsive 3-column layout built with Livewire and Tailwind CSS.
- **Interactive "Try It Out" Panel:** Test any endpoint directly from your browser.
- **Global Authentication:** Configure Bearer Tokens, Basic Auth, or API Keys directly from the dashboard to authenticate your test requests.
- **Auto-Discovery:** Automatically detects endpoints, methods, and route groups.
- **Zero Config Required:** Just install and visit `/docs/api`!

📦 Installation
--------------

[](#-installation)

You can install the package via composer:

```
composer require php-nl/laravel-api-doc
```

Next, you can publish the configuration file and assets using:

```
php artisan vendor:publish --provider="PhpNl\LaravelApiDoc\LaravelApiDocServiceProvider"
```

🚀 Usage
-------

[](#-usage)

Once installed, simply navigate to the predefined documentation route in your browser:

```
http://your-app.test/docs/api

```

You will be greeted by the API Documentation Dashboard. From here you can:

1. Browse through your API routes logically grouped by domain.
2. View the description, parameters, and required payloads for each route.
3. Use the **Security &amp; Authentication** configuration to authenticate globally.
4. Execute real-time requests against your application.

### Defining Endpoints

[](#defining-endpoints)

The package leverages Laravel's native routing metadata and reflection to parse documentation. Standard PHPDoc blocks, FormRequest validations, and route groupings are automatically extracted to document your API.

### Global Authentication

[](#global-authentication)

When interacting with private APIs, you don't need to manually enter tokens for every request. On the Welcome Screen of the documentation dashboard, use the **Security &amp; Authentication** panel to define yours:

- Bearer Token
- Basic Auth
- API Key (Header or Query Parameter)

Once set, this authentication state is persisted for your session and can be toggled per-endpoint when running test queries.

⚙️ Configuration
----------------

[](#️-configuration)

You can fully customize the look and feel, available themes, and base extraction rules by modifying the published configuration file at `config/laravel-api-doc.php`.

```
return [
    'ui' => [
        'title' => 'My API Documentation',
        'theme' => [
            'primary_color' => '#3b82f6', // Customize your brand color!
            'background_color' => '#f8fafc',
        ],
    ],
    // ...
];
```

🧪 Testing
---------

[](#-testing)

```
composer test
```

🛠 Contributing
--------------

[](#-contributing)

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

🔒 Security Vulnerabilities
--------------------------

[](#-security-vulnerabilities)

If you discover any security-related issues, please email directly instead of using the issue tracker.

📄 License
---------

[](#-license)

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

###  Health Score

22

—

LowBetter than 24% of packages

Maintenance65

Regular maintenance activity

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity11

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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://www.gravatar.com/avatar/a312a14822b84080fe3fe8b6db51d324499900f08ffbc39eed4b2f0bf33c02b0?d=identicon)[SERFF](/maintainers/SERFF)

---

Top Contributors

[![SERFF](https://avatars.githubusercontent.com/u/588086?v=4)](https://github.com/SERFF "SERFF (3 commits)")

### Embed Badge

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

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

###  Alternatives

[google/apiclient

Client library for Google APIs

9.8k186.9M907](/packages/google-apiclient)[stripe/stripe-php

Stripe PHP Library

4.0k139.3M422](/packages/stripe-stripe-php)[webonyx/graphql-php

A PHP port of GraphQL reference implementation

4.7k75.4M281](/packages/webonyx-graphql-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k90.6M253](/packages/twilio-sdk)[friendsofsymfony/jsrouting-bundle

A pretty nice way to expose your Symfony routing to client applications.

1.5k52.7M210](/packages/friendsofsymfony-jsrouting-bundle)[knplabs/github-api

GitHub API v3 client

2.2k15.3M173](/packages/knplabs-github-api)

PHPackages © 2026

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