Skip to content

Use serialized_name in Swagger UI Links section #3789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Use serialized_name in Swagger UI Links section #3789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c75180
Use serializedName in Swagger UI Links section
maxtorete Nov 9, 2020
93934c4
Use identifier property name as URI parameter name in SwaggerUI Links…
maxtorete Nov 10, 2020
b41cd36
Fix URI parameter name in testNormalizeWithCustomSerializedName
maxtorete Nov 10, 2020
23f5381
Merge branch '2.5' into patch-3
maxtorete Nov 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/Metadata/Property/Factory/SerializerPropertyMetadataFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ public function create(string $resourceClass, string $property, array $options =
return $propertyMetadata;
}

$serializerMetadataAttributes = $this->serializerClassMetadataFactory->getMetadataFor($resourceClass)->getAttributesMetadata();
if (!empty($serializerMetadataAttributes[$property]) && null !== ($serializedName = $serializerMetadataAttributes[$property]->getSerializedName())) {
$propertyMetadata = $propertyMetadata->withSerializedName($serializedName);
}

$propertyMetadata = $this->transformReadWrite($propertyMetadata, $resourceClass, $property, $normalizationGroups, $denormalizationGroups);

return $this->transformLinkStatus($propertyMetadata, $normalizationGroups, $denormalizationGroups);
Expand Down
23 changes: 22 additions & 1 deletion src/Metadata/Property/PropertyMetadata.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ final class PropertyMetadata
private $attributes;
private $subresource;
private $initializable;
private $serializedName;

public function __construct(Type $type = null, string $description = null, bool $readable = null, bool $writable = null, bool $readableLink = null, bool $writableLink = null, bool $required = null, bool $identifier = null, string $iri = null, $childInherited = null, array $attributes = null, SubresourceMetadata $subresource = null, bool $initializable = null)
public function __construct(Type $type = null, string $description = null, bool $readable = null, bool $writable = null, bool $readableLink = null, bool $writableLink = null, bool $required = null, bool $identifier = null, string $iri = null, $childInherited = null, array $attributes = null, SubresourceMetadata $subresource = null, bool $initializable = null, string $serializedName = null)
{
$this->type = $type;
$this->description = $description;
Expand All @@ -51,6 +52,7 @@ public function __construct(Type $type = null, string $description = null, bool
$this->attributes = $attributes;
$this->subresource = $subresource;
$this->initializable = $initializable;
$this->serializedName = $serializedName;
}

/**
Expand Down Expand Up @@ -343,4 +345,23 @@ public function withInitializable(bool $initializable): self

return $metadata;
}

/**
* Gets custom serialized name of this property.
*/
public function getSerializedName(): ?string
{
return $this->serializedName;
}

/**
* Returns a new instance with the given serialized name.
*/
public function withSerializedName(string $serializedName = null): self
{
$metadata = clone $this;
$metadata->serializedName = $serializedName;

return $metadata;
}
}
1 change: 1 addition & 0 deletions src/Swagger/Serializer/DocumentationNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -793,6 +793,7 @@ private function getLinkObject(string $resourceClass, string $operationId, strin
continue;
}

$propertyName = $propertyMetadata->getSerializedName() ?? $propertyName;
$linkObject['parameters'][$propertyName] = sprintf('$response.body#/%s', $propertyName);
$identifiers[] = $propertyName;
}
Expand Down
10 changes: 10 additions & 0 deletions tests/Metadata/Property/Factory/SerializerPropertyMetadataFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ public function testCreate($readGroups, $writeGroups)
$dummySerializerClassMetadata->addAttributeMetadata($relatedDummySerializerAttributeMetadata);
$nameConvertedSerializerAttributeMetadata = new SerializerAttributeMetadata('nameConverted');
$dummySerializerClassMetadata->addAttributeMetadata($nameConvertedSerializerAttributeMetadata);
$nameSerializedSerializerAttributeMetadata = new SerializerAttributeMetadata('nameSerialized');
$nameSerializedSerializerAttributeMetadata->setSerializedName('name_serialized');
$dummySerializerClassMetadata->addAttributeMetadata($nameSerializedSerializerAttributeMetadata);
$serializerClassMetadataFactoryProphecy->getMetadataFor(Dummy::class)->willReturn($dummySerializerClassMetadata);
$relatedDummySerializerClassMetadata = new SerializerClassMetadata(RelatedDummy::class);
$idSerializerAttributeMetadata = new SerializerAttributeMetadata('id');
Expand All @@ -105,6 +108,9 @@ public function testCreate($readGroups, $writeGroups)
$nameConvertedPropertyMetadata = (new PropertyMetadata())
->withType(new Type(Type::BUILTIN_TYPE_STRING, true));
$decoratedProphecy->create(Dummy::class, 'nameConverted', [])->willReturn($nameConvertedPropertyMetadata);
$nameSerializedPropertyMetadata = (new PropertyMetadata())
->withType(new Type(Type::BUILTIN_TYPE_STRING, true));
$decoratedProphecy->create(Dummy::class, 'nameSerialized', [])->willReturn($nameSerializedPropertyMetadata);

$resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
$resourceClassResolverProphecy->isResourceClass(RelatedDummy::class)->willReturn(true);
Expand All @@ -116,6 +122,7 @@ public function testCreate($readGroups, $writeGroups)
$actual[] = $serializerPropertyMetadataFactory->create(Dummy::class, 'foo');
$actual[] = $serializerPropertyMetadataFactory->create(Dummy::class, 'relatedDummy');
$actual[] = $serializerPropertyMetadataFactory->create(Dummy::class, 'nameConverted');
$actual[] = $serializerPropertyMetadataFactory->create(Dummy::class, 'nameSerialized');

$this->assertInstanceOf(PropertyMetadata::class, $actual[0]);
$this->assertFalse($actual[0]->isReadable());
Expand All @@ -130,6 +137,9 @@ public function testCreate($readGroups, $writeGroups)
$this->assertInstanceOf(PropertyMetadata::class, $actual[2]);
$this->assertFalse($actual[2]->isReadable());
$this->assertFalse($actual[2]->isWritable());

$this->assertInstanceOf(PropertyMetadata::class, $actual[3]);
$this->assertEquals($actual[3]->getSerializedName(), 'name_serialized');
}

public function groupsProvider(): array
Expand Down
4 changes: 4 additions & 0 deletions tests/Metadata/Property/PropertyMetadataTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ public function testValueObject()
$newMetadata = $metadata->withInitializable(true);
$this->assertNotSame($metadata, $newMetadata);
$this->assertTrue($newMetadata->isInitializable());

$newMetadata = $metadata->withSerializedName('foo');
$this->assertNotSame($metadata, $newMetadata);
$this->assertEquals('foo', $newMetadata->getSerializedName());
}

public function testShouldReturnRequiredFalseWhenRequiredTrueIsSetButMaskedByWritableFalse()
Expand Down
144 changes: 144 additions & 0 deletions tests/Swagger/Serializer/DocumentationNormalizerV3Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3131,4 +3131,148 @@ private function doTestNormalizeWithCustomFormatsDefinedAtOperationLevel(Operati

$this->assertEquals($expected, $normalizer->normalize($documentation, DocumentationNormalizer::FORMAT, ['base_url' => '/']));
}

public function testNormalizeWithCustomSerializedName(): void
{
$documentation = new Documentation(new ResourceNameCollection([Dummy::class]), 'Test API', 'This is a test API.', '1.2.3');

$propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
$propertyNameCollectionFactoryProphecy->create(Dummy::class, Argument::cetera())->willReturn(new PropertyNameCollection(['id']));

$dummyMetadata = new ResourceMetadata(
'Dummy',
'This is a dummy.',
'http://schema.example.com/Dummy',
[
'get' => ['method' => 'GET'] + self::OPERATION_FORMATS,
],
[
'post' => ['method' => 'POST'] + self::OPERATION_FORMATS,
]
);
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
$resourceMetadataFactoryProphecy->create(Dummy::class)->willReturn($dummyMetadata);

$propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
$propertyMetadataFactoryProphecy->create(Dummy::class, 'id', Argument::cetera())->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_INT), 'This is an id.', true, false, null, null, null, true, null, null, [], null, null, 'code'));

$operationPathResolver = new OperationPathResolver(new UnderscorePathSegmentNameGenerator());

$normalizer = new DocumentationNormalizer(
$resourceMetadataFactoryProphecy->reveal(),
$propertyNameCollectionFactoryProphecy->reveal(),
$propertyMetadataFactoryProphecy->reveal(),
null,
null,
$operationPathResolver,
null,
null,
null, false,
'',
'',
'',
'',
[],
[],
null,
false,
'page',
false,
'itemsPerPage',
[],
false,
'pagination',
['spec_version' => 3]
);

$expected = [
'openapi' => '3.0.2',
'info' => [
'title' => 'Test API',
'description' => 'This is a test API.',
'version' => '1.2.3',
],
'paths' => new \ArrayObject([
'/dummies' => [
'post' => new \ArrayObject([
'tags' => ['Dummy'],
'operationId' => 'postDummyCollection',
'summary' => 'Creates a Dummy resource.',
'requestBody' => [
'content' => [
'application/ld+json' => [
'schema' => ['$ref' => '#/components/schemas/Dummy'],
],
],
'description' => 'The new Dummy resource',
],
'responses' => [
201 => [
'description' => 'Dummy resource created',
'content' => [
'application/ld+json' => [
'schema' => ['$ref' => '#/components/schemas/Dummy'],
],
],
'links' => [
'GetDummyItem' => [
'operationId' => 'getDummyItem',
'parameters' => ['code' => '$response.body#/code'],
'description' => 'The `code` value returned in the response can be used as the `code` parameter in `GET /dummies/{id}`.',
],
],
],
400 => ['description' => 'Invalid input'],
404 => ['description' => 'Resource not found'],
],
]),
],
'/dummies/{id}' => [
'get' => new \ArrayObject([
'tags' => ['Dummy'],
'operationId' => 'getDummyItem',
'summary' => 'Retrieves a Dummy resource.',
'parameters' => [
[
'name' => 'id',
'in' => 'path',
'schema' => ['type' => 'string'],
'required' => true,
],
],
'responses' => [
'200' => [
'description' => 'Dummy resource response',
'content' => [
'application/ld+json' => [
'schema' => ['$ref' => '#/components/schemas/Dummy'],
],
],
],
'404' => ['description' => 'Resource not found'],
],
]),
],
]),
'components' => [
'schemas' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
'id' => new \ArrayObject([
'type' => 'integer',
'description' => 'This is an id.',
'readOnly' => true,
]),
],
'additionalProperties' => false,
]),
]),
],
];

$this->assertEquals($expected, $normalizer->normalize($documentation, DocumentationNormalizer::FORMAT, ['base_url' => '/']));
}
}