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.0.2 2025-06-10 15:47 UTC

Requires

• php: ^8.1
• illuminate/console: ^9.0|^10.0|^11.0|^12.0
• illuminate/support: ^9.0|^10.0|^11.0|^12.0

Requires (Dev)

• orchestra/testbench: >=8.18
• phpunit/phpunit: >=10.5

GPL-3.0-only

• Mike Garde

• api docs
• cli
• annotation
• routes
• attribute
• laravel
• Developer tools
• Postman
• openapi
• route docs

README

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

Features

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

TODO:

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

Installation

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

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

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.