Jurager/Documentator

Generate OpenAPI 3.0 specifications from Laravel routes, validation rules, and API resources.

Installation

Documentator requires PHP 8.3 or greater and Laravel 10–13:

composer require jurager/documentator
php artisan documentator:generate

Your specification is written to docs/openapi.json. Routes matching api/* are included by default.

Documenting Endpoints

Add descriptions and examples to your controller methods:

/**
 * List users.
 *
 * @group Users
 * @preset pagination
 * @queryParam search string optional Filter by name.
 */

Request fields are read from validation rules and response fields from API resources. See the documentation or the installation guide to get started.

License

The MIT License. See LICENSE.