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.