Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-symfony
APItoolkit's Symfony (PHP) client SDK.
https://github.com/apitoolkit/apitoolkit-symfony
apitoolkit apitoolkit-sdk php symfony
Last synced: about 17 hours ago
JSON representation
APItoolkit's Symfony (PHP) client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-symfony
- Owner: apitoolkit
- License: mit
- Created: 2022-12-14T13:13:11.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-04T10:26:12.000Z (4 months ago)
- Last Synced: 2024-10-31T18:07:14.655Z (7 days ago)
- Topics: apitoolkit, apitoolkit-sdk, php, symfony
- Language: PHP
- Homepage: https://apitoolkit.io/docs/sdks/php/symfony/
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Symfony SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://discord.gg/dEB6EjQnKB) [](https://apitoolkit.io/docs/sdks/php/symfony?utm_source=github-sdks)
APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Symfony (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-symfony
```
## Configuration
First, add the `APITOOLKIT_KEY` environment variable to your `.env` file, like so:
```sh
APITOOLKIT_KEY={ENTER_YOUR_API_KEY_HERE}
```
Then, add the `APIToolkit\EventSubscriber\APIToolkitService` listener and API Key to your `config/service.yaml` file, like so:
```yaml
# This file is the entry point to configure your own services.
# Files in the packages/ subdirectory configure your dependencies.
# Put parameters here that don't need to change on each machine where the app is deployed
# https://symfony.com/doc/current/best_practices.html#use-parameters-for-application-configuration
parameters:
locale: 'en'
services:
# default configuration for services in *this* file
_defaults:
autowire: true # Automatically injects dependencies in your services.
autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
APIToolkit\EventSubscriber\APIToolkitService:
arguments:
$apiKey: '%env(APITOOLKIT_KEY)%'
# makes classes in src/ available to be used as services
# this creates a service per class whose id is the fully-qualified class name
App\:
resource: '../src/'
exclude:
- '../src/DependencyInjection/'
- '../src/Entity/'
- '../src/Kernel.php'
# add more service definitions when explicit configuration is needed
# please note that last definitions always *replace* previous ones
```
> [!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_source=github-sdks) 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/symfony?utm_source=github-sdks).
## 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://discord.gg/dEB6EjQnKB).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-symfony/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
