jurager / documentator

1.0 2026-07-13 05:19 UTC

Requires

• php: ^8.3
• fakerphp/faker: ^1.23
• illuminate/console: ^10.0|^11.0|^12.0|^13.0
• illuminate/routing: ^10.0|^11.0|^12.0|^13.0
• illuminate/support: ^10.0|^11.0|^12.0|^13.0
• nikic/php-parser: ^5.0

Requires (Dev)

• laravel/pint: ^1.25

MIT

• Yuri Gerassimov

• documentation
• api
• laravel
• swagger
• openapi

Published on Packagist.org on 2026-07-22 12:35 UTC

README

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.