PHPackages                             kmapidocvendor/laravel-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. kmapidocvendor/laravel-api-docs

ActiveLibrary[API Development](/categories/api)

kmapidocvendor/laravel-api-docs
===============================

A Laravel package for generating API documentation

00PHP

Since Jun 6Pushed 11mo agoCompare

[ Source](https://github.com/keshu-prog/laravel-api-docs-package)[ Packagist](https://packagist.org/packages/kmapidocvendor/laravel-api-docs)[ RSS](/packages/kmapidocvendor-laravel-api-docs/feed)WikiDiscussions development Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Laravel API Docs Generator 📘
============================

[](#laravel-api-docs-generator-)

A simple and developer-friendly Laravel package for auto-generating API documentation directly from your Laravel routes, views, and controller metadata.

---

🚀 Features
----------

[](#-features)

- Automatically scans your routes and generates documentation
- Artisan command to generate docs
- Blade view integration for web-based display
- Easy customization by publishing views

---

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

[](#-installation)

### Step 1: Add Local Repository

[](#step-1-add-local-repository)

If you're developing this package locally from a `packages/` directory, add the following to your root project's `composer.json`:

```
"repositories": [
  {
    "type": "path",
    "url": "packages/KmApiDocVendor/LaravelApiDocs"
  }
]
```

### Step 2: Require the Package

[](#step-2-require-the-package)

Run the following command from your Laravel project root:

```
composer require kmapidocvendor/laravel-api-docs:@dev
composer dump-autoload
```

### Step 3: Register the Service Provider (if not using auto-discovery)

[](#step-3-register-the-service-provider-if-not-using-auto-discovery)

If your Laravel version is below 5.5 or you're not using auto-discovery, add the provider manually to `config/app.php`:

```
'providers' => [
    // ...
    KmApiDocVendor\LaravelApiDocs\ApiDocsServiceProvider::class,
],
```

### Step 4: Publish the Views (optional)

[](#step-4-publish-the-views-optional)

To customize the documentation UI:

```
php artisan vendor:publish --provider="KmApiDocVendor\LaravelApiDocs\ApiDocsServiceProvider"
```

This will publish the view files to:

```
resources/views/vendor/kmapidocs/

```

---

⚙️ Usage
--------

[](#️-usage)

### 1. Generate the Documentation

[](#1-generate-the-documentation)

Use the artisan command to generate API documentation:

```
php artisan kmapidoc:generate
```

This will scan your routes/controllers and create structured docs.

---

### 2. View Documentation in the Browser

[](#2-view-documentation-in-the-browser)

Once generated, you can view the documentation at:

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

```

The view is rendered via:

```
$this->loadViewsFrom(__DIR__.'/resources/views', 'kmapidocs');
```

---

🛠 Customizing the View
----------------------

[](#-customizing-the-view)

If you published the views, you can customize the layout or design:

```
resources/views/vendor/kmapidocs/api-docs.blade.php

```

---

📂 Project Structure
-------------------

[](#-project-structure)

```
packages/
└── KmApiDocVendor/
    └── LaravelApiDocs/
        ├── src/
        │   ├── ApiDocsServiceProvider.php
        │   └── Console/
        │       └── GenerateDocsCommand.php
        ├── resources/
        │   └── views/
        │       └── api-docs.blade.php
        └── routes/
            └── web.php

```

---

🧪 Compatibility
---------------

[](#-compatibility)

- Laravel Versions Supported: ^8.0, ^9.0, ^10.0, ^11.0, ^12.0
- PHP Version Required: ^8.0

---

🤝 Contributing
--------------

[](#-contributing)

Feel free to fork, improve, and send a pull request.
All contributions are welcome and appreciated!

---

📄 License
---------

[](#-license)

MIT License © Keshab Chandra Mandal

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance39

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity14

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/bb1557eeb878356f1e226f647e7efe9e4bb8da8658a2fa6fc0dbbe5361dc9dee?d=identicon)[keshu-prog](/maintainers/keshu-prog)

---

Top Contributors

[![keshu-prog](https://avatars.githubusercontent.com/u/55343498?v=4)](https://github.com/keshu-prog "keshu-prog (1 commits)")

### Embed Badge

![Health badge](/badges/kmapidocvendor-laravel-api-docs/health.svg)

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M452](/packages/google-gax)

PHPackages © 2026

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