https://github.com/piovezanfernando/laravel-api-auto-docs
Automatically generate Laravel API documentation from request rules, controllers and routes
https://github.com/piovezanfernando/laravel-api-auto-docs
api-documentation auto-documentation laravel laravel-api-auto-docs laravel-request open-source php8
Last synced: 3 months ago
JSON representation
Automatically generate Laravel API documentation from request rules, controllers and routes
- Host: GitHub
- URL: https://github.com/piovezanfernando/laravel-api-auto-docs
- Owner: piovezanfernando
- License: other
- Created: 2025-12-12T20:45:45.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2026-03-26T18:36:26.000Z (3 months ago)
- Last Synced: 2026-03-27T07:49:41.961Z (3 months ago)
- Topics: api-documentation, auto-documentation, laravel, laravel-api-auto-docs, laravel-request, open-source, php8
- Language: PHP
- Homepage: https://piovezanfernando.github.io/laravel-api-auto-docs/
- Size: 1020 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel API Auto Docs
The Hassle-Free automatic API documentation generation for Laravel.
A Swagger alternative with modern Vue 3 interface.
Supports Open API 3.0.0
## Features
- ✨ Light and Dark mode
- 🚀 Automatic rules fetching from injected Request and by regexp
- 📋 Automatic routes fetching from Laravel Routes
- 📝 Support for Laravel logs
- 🗃️ Support for SQL query and query time analysis
- ⚡ Support for memory consumption
- 🔐 Support for Authorization Headers
- 🎯 Support for Eloquent events
- 🔄 Support for OpenAPI 3.0.0 exports
- 🎨 Modern Vue 3 interface
## Requirements
- PHP >= 8.3
- Laravel 11.x | 12.x | 13.x
## Installation
You can install the package via composer:
```bash
composer require piovezanfernando/laravel-api-auto-docs
```
Publish the config file:
```bash
php artisan vendor:publish --tag="api-auto-docs-config"
```
## Configuration
The configuration file will be published to `config/api-auto-docs.php`. Here you can configure:
- Routes to document
- Middleware to apply
- UI customizations
- And more...
## Usage
### Accessing the Documentation
By default, the documentation is available at:
```
http://your-app.test/docs-api
```
### Generating OpenAPI Specification
To generate the OpenAPI specification file:
```bash
php artisan api-docs:export
```
This will create an `api.json` file in your project's root directory by default. You can specify a different path:
```bash
php artisan api-docs:export storage/app/api.json
```
### Adding Descriptions to Controllers
The package automatically reads the summary and description from your controller methods' PHPDoc comments.
```php
class UserController extends Controller
{
/**
* Create a new user.
*
* This endpoint allows you to create a new user in the system.
* The user's name, email, and password are required.
*/
public function store(CreateUserRequest $request)
{
// Your code here
}
}
```
### Request Validation
The package automatically reads Laravel FormRequest validation rules:
```php
class CreateUserRequest extends FormRequest
{
public function rules()
{
return [
'name' => 'required|string|max:255',
'email' => 'required|email|unique:users',
'password' => 'required|string|min:8',
];
}
}
```
## Configuration Options
### Exclude Routes
In `config/api-auto-docs.php`:
```php
'hide_matching' => [
'#^api/internal#',
'#^_debugbar#',
],
```
### Middleware
```php
'middlewares' => [
'web',
'auth', // Add if you want authentication
],
```
### UI Customization
```php
'title' => 'My API Documentation',
'default_headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
```
## Testing Your API
The built-in UI allows you to:
- 📤 Send requests directly from the browser
- 📊 View SQL queries and memory usage
- 📋 See logs and debug information
- 💾 Export to OpenAPI format
## Export Options
### OpenAPI 3.0
Access the OpenAPI specification:
```
http://your-app.test/docs-api/api?openapi=true
```
Download the JSON representation via:
```
http://your-app.test/docs-api/api?json=true
```
## Security
If you want to restrict access to the documentation:
```php
// config/api-auto-docs.php
'middlewares' => [
'web',
'auth',
'can:view-api-docs', // Custom gate
],
```
### Credits
This package is based on the excellent work from
[Laravel Request Docs](https://github.com/rakutentech/laravel-request-docs) by Rakuten Tech.
All credit for the original idea and implementation goes to
Pulkit Kathuria and the Rakuten Tech engineering team.
This fork extends the original project with additional features, UI redesign,
and ongoing maintenance, while preserving the MIT license.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Support
- **Issues**: [GitHub Issues](https://github.com/piovezanfernando/laravel-api-auto-docs/issues)
- **Original Project**: [Laravel Request Docs](https://github.com/rakutentech/laravel-request-docs)
## Colaboradores
