Laravel API Documentation Generator with multiple UI themes and OpenAPI 3+ support
x-multibyte/laravel-api-docs is a Laravel package for laravel api documentation generator with multiple ui themes and openapi 3+ support.
It currently has 0 GitHub stars and 4 downloads on Packagist (latest version v1.0.1).
Install it with composer require x-multibyte/laravel-api-docs.
Discover more Laravel packages by x-multibyte
or browse all Laravel packages to compare alternatives.
Last updated
A comprehensive Laravel package for automatically generating beautiful API documentation from your Laravel routes. Supports multiple UI themes including Swagger UI, ReDoc, and RapiDoc with OpenAPI 3+ specification.
You can install the package via Composer:
composer require x-multibyte/laravel-api-docs
The package will automatically register its service provider through Laravel's package auto-discovery feature.
If you need to manually register the service provider, add it to your config/app.php:
'providers' => [
// Other Service Providers
XMultibyte\ApiDoc\ApiDocsServiceProvider::class,
],
php artisan api-docs:publish --config
php artisan api-docs:generate
Visit http://your-app.test/api-docs in your browser.
The configuration file will be published to config/api-docs.php. Here are the key configuration options:
return [
// Basic API information
'title' => 'My API Documentation',
'version' => '1.0.0',
'description' => 'Comprehensive API documentation',
// Route configuration
'route_prefix' => 'api-docs',
'middleware' => ['web'],
// Default theme
'default_theme' => 'swagger',
// Route scanning
'scan_routes' => [
'prefix' => 'api',
'exclude' => ['telescope', 'horizon']
],
// OpenAPI configuration
'openapi' => [
'version' => '3.0.3',
'servers' => [
[
'url' => env('APP_URL'),
'description' => 'Development server'
]
]
]
];
Generate API documentation from your Laravel routes:
# Basic generation
php artisan api-docs:generate
# Generate with specific format
php artisan api-docs:generate --format=yaml
# Generate both JSON and YAML
php artisan api-docs:generate --format=both
# Generate with validation
php artisan api-docs:generate --validate
# Generate specific routes only
php artisan api-docs:generate --routes="api/users/*,api/posts/*"
# Exclude specific routes
php artisan api-docs:generate --exclude="api/admin/*"
Import existing OpenAPI specifications:
# Import from JSON file
php artisan api-docs:import openapi.json
# Import with validation and backup
php artisan api-docs:import openapi.yaml --validate --backup
# Merge with existing specification
php artisan api-docs:import openapi.json --merge
Generate static HTML documentation files:
# Generate static files for all themes
php artisan api-docs:static
# Generate specific themes
php artisan api-docs:static --themes=swagger,redoc
# Generate with custom output path
php artisan api-docs:static --output=/path/to/output
# Generate minified HTML
php artisan api-docs:static --minify
# Generate with custom base URL
php artisan api-docs:static --base-url=https://docs.example.com
Clean up generated documentation files:
# Clean all files (dry run)
php artisan api-docs:clean --all --dry-run
# Clean backup files older than 7 days
php artisan api-docs:clean --backups --older-than=7
# Clean cache files
php artisan api-docs:clean --cache
# Clean generated files
php artisan api-docs:clean --generated
View documentation status and statistics:
# Basic status
php artisan api-docs:status
# Detailed status with route analysis
php artisan api-docs:status --detailed
# Show route analysis only
php artisan api-docs:status --routes
# Show file information only
php artisan api-docs:status --files
Publish package files for customization:
# Publish all files
php artisan api-docs:publish --all
# Publish configuration only
php artisan api-docs:publish --config
# Publish views only
php artisan api-docs:publish --views
# Publish assets only
php artisan api-docs:publish --assets
Display help information:
php artisan api-docs:help
The default theme using Swagger UI for interactive API documentation.
Features:
Beautiful, responsive API documentation with ReDoc.
Features:
Modern API documentation with RapiDoc.
Features:
Create your own custom theme by extending the base theme system.
You can customize how routes are detected and processed:
// In your configuration
'scan_routes' => [
'prefix' => 'api',
'exclude' => [
'telescope',
'horizon',
'debugbar',
'_ignition'
],
'include_middleware' => [
'api',
'auth:api',
'auth:sanctum'
]
]
Protect your documentation with authentication:
'security' => [
'enabled' => true,
'middleware' => ['auth'],
'allowed_ips' => ['127.0.0.1'],
'basic_auth' => [
'enabled' => true,
'username' => env('API_DOCS_USERNAME'),
'password' => env('API_DOCS_PASSWORD')
]
]
Enable caching for better performance:
'cache' => [
'enabled' => true,
'ttl' => 3600, // 1 hour
'key_prefix' => 'api_docs',
'store' => 'redis'
]
Generate static files for deployment:
'static' => [
'output_path' => storage_path('api-docs/static'),
'base_url' => 'https://docs.example.com',
'themes' => ['swagger', 'redoc'],
'minify_html' => true,
'include_assets' => true,
'generate_sitemap' => true
]
The package includes a comprehensive test suite:
# Run all tests
composer test
# Run tests with coverage
composer test-coverage
# Run code style checks
composer cs-check
# Fix code style issues
composer cs-fix
# Run all quality checks
composer test-all
The package includes factory classes for testing:
use XMultibyte\ApiDoc\Tests\Concerns\UsesFactories;
class MyTest extends TestCase
{
use UsesFactories;
public function test_something()
{
$spec = $this->createOpenApiSpec();
$route = $this->createRoute('GET', 'api/users');
// Your test logic here
}
}
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details on how to contribute to this project.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
For general support and questions, please use the GitHub Discussions or open an issue on GitHub.
