Skip to content

chore(): don't serialize non @Exposable entities in properties #3

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

Open
BigZ wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore(): don't serialize non @Exposable entities in properties #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 47 additions & 0 deletions Command/DumpApiDocCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Filesystem\Filesystem;
use Nelmio\ApiDocBundle\ApiDocGenerator;
use Doctrine\Common\Annotations\AnnotationReader;
use WizardsRest\Annotation\Exposable;

/**
* Class GenerateSwaggerDocumentationCommand
Expand All @@ -29,6 +31,8 @@ class DumpApiDocCommand extends Command
*/
private $generator;

private $reader;

/**
* DumpApiDocCommand constructor.
*
Expand All @@ -39,6 +43,8 @@ public function __construct(ApiDocGenerator $generator, $name = null)
{
$this->generator = $generator;

$this->reader = new AnnotationReader();

parent::__construct($name);
}

Expand Down Expand Up @@ -70,6 +76,7 @@ protected function execute(InputInterface $input, OutputInterface $output)

if ($this->isJsonApi($apiDoc) && isset($apiDoc['definitions'])) {
$apiDoc['definitions'] = $this->removeIdFromDefinitions($apiDoc['definitions']);
$apiDoc['definitions'] = $this->removeRelationsFromDefinitions($apiDoc['definitions']);
}

$jsonSchema = json_encode($apiDoc, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
Expand Down Expand Up @@ -125,6 +132,46 @@ private function removeIdFromDefinitions(array $definitionList)
return $definitionList;
}

/**
* Relationships are managed as HATEOAS in jsonapi.
*
* @param array $definitionList
*
* @return array
*/
private function removeRelationsFromDefinitions(array $definitionList)
{
foreach ($definitionList as $definitionName => $definition) {
if (isset($definition['properties'])) {
foreach ($definition['properties'] as $propertyId => $property) {
// if property is a relationship
if (isset($property['$ref']) || isset($property['items']['$ref'])) {
// check in the entity s actually a relation
try {
$reflection = new \ReflectionClass(
sprintf('App\\Entity\\%s', ucfirst($definitionName))
);
if (
$reflection
&& $reflection->hasProperty($propertyId)
&& null === $this->reader->getPropertyAnnotation(
$reflection->getProperty($propertyId),
Exposable::class
)
) {
unset($definitionList[$definitionName]['properties'][$propertyId]);
}
} catch (\Exception $exception) {
// property is not a relation. skip.
}
}
}
}
}

return $definitionList;
}

private function isJsonApi($apiDoc)
{
return isset($apiDoc['produces']) && in_array('application/vnd.api+json', $apiDoc['produces']);
Expand Down
3 changes: 2 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"require": {
"php": ">5.5",
"nelmio/api-doc-bundle": "^3.3.1",
"symfony/console": "^4"
"symfony/console": "^4",
"wizards/rest-bundle": "^0.9.7"
},
"require-dev": {
"phpunit/phpunit": ">5.7"
Expand Down