Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtarld/api-platform-ms-bundle
A set of tools to use Api Platform in a microservice context
https://github.com/mtarld/api-platform-ms-bundle
api-platform microservice-bundle symfony
Last synced: 3 days ago
JSON representation
A set of tools to use Api Platform in a microservice context
- Host: GitHub
- URL: https://github.com/mtarld/api-platform-ms-bundle
- Owner: mtarld
- License: mit
- Created: 2020-04-10T06:04:14.000Z (over 4 years ago)
- Default Branch: 1.x
- Last Pushed: 2024-10-16T15:16:10.000Z (2 months ago)
- Last Synced: 2024-10-18T09:14:57.110Z (2 months ago)
- Topics: api-platform, microservice-bundle, symfony
- Language: PHP
- Homepage:
- Size: 169 KB
- Stars: 66
- Watchers: 3
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# API Platform Microservice Bundle
[](https://github.com/mtarld/api-platform-ms-bundle/actions)
A Microservice tools bundle for API Platform.
## A microservice bundle ?
In a microservice context where each microservices are API Platform instances,
each instance must behave as an API Platform data producer and an
API Platform data consumer.
But API Platform isn't intended to behave like a client.
Therefore, here comes the API Platform Microservice Bundle!
This bundle intents to provide a set of [tools](#provided-tools)
to ease the development of client behaving microservices by trying to abstract the http call layer.
## Getting started
### Installation
You can easily install API Platform Microservice bundle by composer
```
$ composer require mtarld/api-platform-ms-bundle
```
Then, bundle should be registered. Just verify that `config\bundles.php` is containing :
```php
Mtarld\ApiPlatformMsBundle\ApiPlatformMsBundle::class => ['all' => true],
```
### Configuration
Once the bundle is installed, you should configure it to fit your needs.
To do so, edit `config/packages/api_platform_ms.yaml` and `config/routes/api_platform_ms.yaml`
```yaml
# config/packages/api_platform_ms.yaml
api_platform_ms:
# HttpClient that will be used internally (default: 'Symfony\Contracts\HttpClient\HttpClientInterface')
http_client: ~
# Name of the current microservice (required)
name: client
# Option to log request (default '%kernel.debug%')
log_request: true
# Host used for microservice dynamic routes generation (default: [])
hosts:
- https://client.api
# List of related microservices
microservices:
# Microservice name
product:
# Microservice base uri (required)
base_uri: https://product.api
# Microservice API path (default: '')
api_path: /api
# Microservice format (required)
# Supported formats: jsonld, jsonhal, jsonapi
format: jsonld
```
```yaml
# config/routes/api_platform_ms.yaml
api_platform_ms:
resource: '@ApiPlatformMsBundle/Resources/config/routes.xml'
prefix: /api
```
And you're ready to go ! :rocket:
## Provided tools
- [**API resource existence constraint**](src/Resources/doc/tools/existence-constraint.md):
Help you to ensure that the related resources are existing on the other microservice when doing validation.
- [**Resource collection and pagination**](src/Resources/doc/tools/pagination.md):
Handy objects and services to ease paginated collection iteration.
- [**HTTP repository**](src/Resources/doc/tools/http-repository.md):
An extendable HTTP repository that you could configure to fetch resources.
- [**HTTP client wrappers**](src/Resources/doc/tools/http-wrapper.md):
Clients that adapt HTTP calls according to the targeted microservice configuration.
- [**Authentication header providers**](src/Resources/doc/tools/authentication-header-provider.md):
Providers that dynamically inject authentication headers in requests.
- [**ConstraintViolation list denormalizer**](src/Resources/doc/tools/constraint-violation-list.md):
Allows you to create a `ConstraintViolationList` instance from a serialized string.
- [**Extension points**](src/Resources/doc/tools/extension-points.md):
Events that you can listen to extend the bundle behavior.
## Supported microservice formats
Currently, API Platform supported formats are:
- jsonld
- jsonapi
- jsonhal
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
After writing your fix/feature, you can run following commands to make sure that everything is still ok.
```bash
# Install dev dependencies
$ composer install
# Running tests locally
$ make test
```
## Authors
- Mathias Arlaud - [mtarld](https://github.com/mtarld) -