PHPackages                             mikegarde/laravel-route-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. [CLI & Console](/categories/cli)
4. /
5. mikegarde/laravel-route-docs

ActiveLibrary[CLI & Console](/categories/cli)

mikegarde/laravel-route-docs
============================

A Laravel package that uses PHP attributes to document routes, generate readable route listings, and export OpenAPI or Postman definitions.

1.1.0(12mo ago)02.0k↓26.2%GPL-3.0-onlyPHPPHP ^8.1

Since Jun 9Pushed 12mo agoCompare

[ Source](https://github.com/MikeGarde/laravel-route-docs)[ Packagist](https://packagist.org/packages/mikegarde/laravel-route-docs)[ RSS](/packages/mikegarde-laravel-route-docs/feed)WikiDiscussions main Synced 3d ago

READMEChangelog (4)Dependencies (4)Versions (6)Used By (0)

Laravel Route Docs
==================

[](#laravel-route-docs)

[![Latest Version on Packagist](https://camo.githubusercontent.com/08a641a321f0edd2ac7bc939245ed6d5019753f049c2ddc649aaf34bce4dcbbd/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d696b6567617264652f6c61726176656c2d726f7574652d646f63732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/mikegarde/laravel-route-docs)[![codecov](https://camo.githubusercontent.com/73326d7948cbc3cbc145771d90ece34937719b821dff77b696f3d05844c09bd3/68747470733a2f2f636f6465636f762e696f2f67682f6d696b6567617264652f6c61726176656c2d726f7574652d646f63732f6272616e63682f6d61696e2f67726170682f62616467652e737667)](https://codecov.io/gh/mikegarde/laravel-route-docs)[![GitHub Tests Action Status](https://camo.githubusercontent.com/4853693bb34951db65a490faa7c0014d73bb8bd8736c3db7d26e7b0a0c1d6e21/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6d696b6567617264652f6c61726176656c2d726f7574652d646f63732f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473)](https://github.com/mikegarde/laravel-route-docs/actions)[![License: GPL v3](https://camo.githubusercontent.com/48bf9b56d44f38db53ce21294cf0b9487d0a3734ab3ba1fe4c69858ae20db2c1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d47504c76332d626c75652e737667)](LICENSE)

A Laravel package that uses PHP attributes to document routes, generate readable route listings, and export OpenAPI or Postman definitions.

---

Features
--------

[](#features)

- Document routes directly using PHP attributes
- Validate route documentation in your CI/CD pipeline
- Includes CLI tooling for discovery and inspection

### TODO:

[](#todo)

- Add request parameters
- Add response schemas
- Export route definitions as JSON, OpenAPI, or Postman collections

---

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

[](#installation)

```
composer require mikegarde/laravel-route-docs --dev
```

Usage
-----

[](#usage)

Annotate your controller methods using custom attributes to describe your API:

```
use RouteDocs\Attributes\get;

class ItemController
{
    #[get('/items', name: 'items.index')]
    public function index()
    {
        return Item::all();
    }
}
```

Then run:

```
php artisan route:docs
```

You’ll get a structured view of your documented routes.

Validate Route Attributes in CI/CD
----------------------------------

[](#validate-route-attributes-in-cicd)

You can validate that all routes have correct and complete attribute annotations:

```
php artisan route:docs:validate
```

This will return non-zero exit codes on failure, making it CI-friendly.

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance50

Moderate activity, may be stable

Popularity20

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Every ~10 days

Total

4

Last Release

360d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1537877?v=4)[Mike Garde](/maintainers/MikeGarde)[@MikeGarde](https://github.com/MikeGarde)

---

Top Contributors

[![MikeGarde](https://avatars.githubusercontent.com/u/1537877?v=4)](https://github.com/MikeGarde "MikeGarde (19 commits)")

---

Tags

clilaravelroutesopenapiannotationdeveloper-toolsattributePostmanapi-docsroute docs

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/mikegarde-laravel-route-docs/health.svg)

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

###  Alternatives

[laravel/sail

Docker files for running a basic Laravel application.

1.9k205.7M1.3k](/packages/laravel-sail)[laravel/ai

The official AI SDK for Laravel.

1.0k3.2M201](/packages/laravel-ai)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

77022.3M151](/packages/laravel-mcp)[propaganistas/laravel-disposable-email

Disposable email validator

6023.0M7](/packages/propaganistas-laravel-disposable-email)[tallstackui/tallstackui

TallStackUI is a powerful suite of Blade components that elevate your workflow of Livewire applications.

725173.2k14](/packages/tallstackui-tallstackui)[laravel/surveyor

Static analysis tool for Laravel applications.

86121.4k13](/packages/laravel-surveyor)

PHPackages © 2026

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