Provides an ability to create more than one API in single app
This Symfony's bundle is a solution to problem for having more than one API in single API Platform instance. For example, you have an application's back-end that exposes resources for end-clients and you want to create an entrypoint for internal microservices.
composer require er1z/multi-api-platform
First, separate your structures. They have to be distinguished via namespace or implemented interface. Suppose we create two APIs: internal and external.
Usually I rely on DTOs (but it should work also for entities). Create two classes:
config/packages/multi_api_platform.yml with following contents:
multi_api_platform: apis: internal: namespace: App\DTO\Internal #implements: App\My\MyInterface conditions: "request.query.has('is_internal')" debug_conditions: "request.query.has('is_internal')" external: namespace: App\DTO\External conditions: "true" debug_conditions: "true"
implements should be configured.
Conditions are not pre-defined in order to obligate you exposing particular API carefully. If you want to expose an API
as is, put
"true" as a value.
debug_conditions are evaluated in
dev environment whereas
conditions only in production.
Conditions are simple but powerful tool to restrict particular API, for example by origin IP, header, environment variable and so on. Check the route conditions documentation how to construct this stuff.
To extend this for your needs you can always create
event listener/subscriber and append some attributes to check against with expression. Be aware to configure your
listener with priority higher than
32 because Symfony's router lives there. Executing your listener after would
produce useless results.
bin/console swagger:api:export is overrided — requires a single argument with desired API name to produce correct dump.
If you are in development environment, it's useful to specify some conditions or use special request attribute to specify an API you want work with. It's enabled by default provided you're on development environment.
x-api-select variable to one of request parameters
files) with specified API name and you're done. It will produce a cookie named with the same name that will
allow to work with Swagger debugger.
Of course, it may be easily tweaked or disabled:
multi_api_platform: debug_http_listener: enabled: true request_param: x-api-select set_cookie: true request_order: ['request', 'query', 'attributes', 'cookies', 'headers', 'server']