Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding some instructions to help disable only the api-debugger #29

Merged
merged 1 commit into from
Apr 21, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ For Laravel 5.4

For Laravel 5.5 package supports [package discovery](https://laravel.com/docs/5.5/packages#package-discovery) feature.

Copy the config file to your own project by running the following command:
```php
php artisan vendor:publish --provider="Lanin\Laravel\ApiDebugger\ServiceProvider"
```

## Json response

Before extension will populate your answer it will try to distinguish if it is a json response. It will do it by validating if it is a JsonResponse instance. The best way to do it is to return `response()->json();` in your controller's method.
Expand Down Expand Up @@ -139,6 +144,7 @@ So be careful with this, because everyone will see your output, but at least deb

**Note!** By default Debugger will collect data ONLY when you set `APP_DEBUG=true`.
So you don't have to worry that someone will see your system data on production.
You can overwrite that by adding `API_DEBUGGER_ENABLED=true|false` to your .env file, or by changing the value of `enabled` in the config file.

All available collections can be found in `api-debugger.php` config that you can publish and update as you wish.

Expand Down