Interactive Laravel API explorer. You don't need to write/update documentation for your API. On the fly, Your API documentation will always be available in an interactive way.
- Quick install (one-step install, no code change needed);
- Zero config needed;
- Store config/parameters to be used anytime;
- Variables: you can set variables (like id's, tokens, etc. to be used in any place like querystring, header, body, etc.);
- Global headers: You can set global headers (like tokens, content-type, etc.) to be used in all requests.
https://laravel-api-explorer-demo.herokuapp.com/api-explorer
You can click on top right icon (wrench) and add your variables. When you will need to set some querystring parameter, header value, body content, etc., you can use ${VARIABLE_NAME}, and this placeholder will be replaced by your variable.
If you API needs some header in all request (or almost), you can set global headers instead of create these headers for every request. You can click on top right icon (wrench) and add your global headers.
Via Composer
$ composer require netojose/laravel-api-explorerYou just need access yourdomain.com/api-explorer
Optionally you can copy config file to override default package configuration
php artisan vendor:publish --provider="NetoJose\LaravelApiExplorer\LaravelApiExplorerServiceProvider"Now you have a config/laravelapiexplorer.php file inside your project,and you can make your changes. Available configurations:
| Configuration | Description | Default |
|---|---|---|
| enabled | Determine if the explorer will available | true |
| route | The route to access explorer page | api-explorer |
| match | Pattern to routes to be available on explorer | api/* |
| ignore | Array of routes to be ignored. You can use a pattern of a route path or route name | [,'/',] |
Please see contributing.md for details and a todolist.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.