Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-laravel
APItoolkit's Laravel (PHP) client SDK.
https://github.com/apitoolkit/apitoolkit-laravel
apitoolkit apitoolkit-sdk laravel php
Last synced: about 17 hours ago
JSON representation
APItoolkit's Laravel (PHP) client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-laravel
- Owner: apitoolkit
- License: mit
- Created: 2022-04-05T04:25:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T09:11:48.000Z (4 months ago)
- Last Synced: 2024-10-13T17:14:54.033Z (25 days ago)
- Topics: apitoolkit, apitoolkit-sdk, laravel, php
- Language: PHP
- Homepage: https://apitoolkit.io/docs/sdks/php/laravel/
- Size: 2.22 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Laravel SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/php/laravel?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme)
APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Laravel (PHP) application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.
---
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Contributing and Help](#contributing-and-help)
- [License](#license)
---
## Installation
Kindly run the command below to install the SDK:
```sh
composer require apitoolkit/apitoolkit-laravel
```
## Configuration
First, add the `APITOOLKIT_KEY` environment variable to your `.env` file like so:
```sh
APITOOLKIT_KEY={ENTER_YOUR_API_KEY_HERE}
```
Next, register the middleware in the `app/Http/Kernel.php` file under the correct middleware group (e.g., `api`) or at the root, like so:
```php
[
// Other middleware here...
\APIToolkit\Http\Middleware\APIToolkit::class, // Initialize the APItoolkit client
],
];
}
```
Alternatively, if you want to monitor specific routes, you can register the middleware, like so:
```php
\APIToolkit\Http\Middleware\APIToolkit::class,
];
}
```
Then you can use the `apitoolkit` middleware in your routes like so:
```php
Route::get('/', function () {
return response()->json([
'message' => 'Welcome to your new application!'
]);
})->middleware('apitoolkit');
```
> [!NOTE]
>
> The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
> [!IMPORTANT]
>
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/php/laravel?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
## Contributing and Help
To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:
- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).
- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-laravel/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
