axeldotdev / laravel-api-doc
This package help you build your REST API documentation.
Fund package maintenance!
axeldotdev
Requires
- php: ^8.1
- doctrine/dbal: ^3.3
- illuminate/contracts: ^9.0
- spatie/laravel-package-tools: ^1.9.2
- spatie/shiki-php: ^1.2
Requires (Dev)
- nunomaduro/collision: ^6.0
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^7.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-10-09 20:13:02 UTC
README
This package help you build your REST API documentation.
Installation
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"
Features
- 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
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.