This package help you build your REST API documentation.
You can install the package via composer:
composer require axeldotdev/laravel-api-doc
You can publish the config file with:
php artisan vendor:publish --tag="laravel-api-doc-config"
Optionally, you can publish the views using
php artisan vendor:publish --tag="laravel-api-doc-views"
- Customizable get started view
- Customizable authentication view
- Customizable errors view
- Auto-generated routes views via API routes, controllers, requests, etc.
- Customizable routes views
- Versions manager
- Copy code examples into the clipboard
Coming soon :
- Fields and params example values, enums values, etc.
- Code examples in Curl, PHP and Javascript
- Static generator into a HTML file
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.