Create README.md

Author: CodeCasterNL

README.md

@@ -0,0 +1,84 @@
+# API Platform extensions bundle
+What is API Platform and how do we extend it?
+
+# Filters
+These filters are added by this bundle:
+
+## GlobalSearchFilter (`api_platform.doctrine.orm.global_search_filter`)
+Searches (recursively?) through the specified columns (or all of them, scary stuff) of an entity on whose endpoint it's activated.
+
+Configure the filter as a service (`config/services/api_platform/search/[$domain/]$entity.yaml`):
+```yaml
+services:
+  api.resource.region.global.search_filter:
+    parent: 'api_platform.doctrine.orm.global_search_filter'
+    arguments: [ {
+      'name': 'partial',
+      'depot.description': 'partial',
+    } ]
+    tags: [ { name: 'api_platform.filter', id: 'api.region.global_search_filter' } ]
+    autowire: false
+    autoconfigure: false
+```
+
+And apply it to the appropriate resource:
+```yaml
+App\Entity\Transport\Region:
+  attributes:
+    route_prefix: /transport
+    filters:
+      - 'api.region.global_search_filter'
+```
+
+Now when a user calls the API with ?search=foo, the query will become something like this:
+
+```sql
+SELECT 
+    r.*
+FROM 
+    region r
+LEFT JOIN
+    depot d
+ON
+    d.id = r.depot_id
+WHERE
+    r.name LIKE '%foo%' 
+    OR d.description LIKE '%foo%'
+```
+
+## OrSearchFilter (`api_platform.doctrine.orm.or_search_filter`)
+TODO
+
+## UuidFilter (`api_platform.doctrine.orm.uuid_filter`)
+For looking up nested entities by their UUID, because API Platform doesn't support that (see https://github.com/api-platform/core/pull/3774, was reverted because it broke date search).
+
+Service configuration:
+```yaml
+services:
+  api.resource.transport_position.vehicle_filter:
+    parent: 'api_platform.doctrine.orm.uuid_filter'
+    arguments: [ {
+      vehicle.id: 'exact'
+    } ]
+    tags: [ { name: 'api_platform.filter', id: 'api.transport_position.vehicle_filter' } ]
+    autowire: false
+    autoconfigure: false
+    public: false
+```
+
+API Platform entity configuration:
+```yaml
+App\Entity\Transport\Position:
+  collectionOperations:
+    get:
+      filters:
+        - 'api.transport_position.vehicle_filter'
+```
+
+Now the API caller can filter using `GET .../transport_positions?vehicle.id=$uuid`.
+
+# Routes
+The bundle introduces the following route(s):
+
+## `/me`
+Get info about the caller. Includes a SwaggerDecorator to generate OpenAPI documentation about this endpoint.