ApiPlatform\Core\Swagger\ApiDocumentationBuilder

Complexity

Total Complexity

48

Size/Duplication

Total Lines	262
Duplicated Lines	23.66 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	14	14	1
F	getApiDocumentation()	8	93	16
C	getSwaggerOperation()	26	78	18
C	getRange()	14	46	13

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ApiPlatform\Core\Swagger;

use ApiPlatform\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Api\OperationMethodResolverInterface;
use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\Api\UrlGeneratorInterface;
use ApiPlatform\Core\JsonLd\ContextBuilderInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use ApiPlatform\Core\Util\ApiDocumentationBuilderInterface;

/**
 * Creates a machine readable Swagger API documentation.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ApiDocumentationBuilder implements ApiDocumentationBuilderInterface
{
    private $resourceNameCollectionFactory;
    private $resourceMetadataFactory;
    private $propertyNameCollectionFactory;
    private $propertyMetadataFactory;
    private $contextBuilder;
    private $resourceClassResolver;
    private $operationMethodResolver;
    private $urlGenerator;
    private $title;
    private $description;
    private $iriConverter;

    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, OperationMethodResolverInterface $operationMethodResolver, UrlGeneratorInterface $urlGenerator, IriConverterInterface $iriConverter, string $title = '', string $description = '')

This method seems to be duplicated in your project.

    {
        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->contextBuilder = $contextBuilder;
        $this->resourceClassResolver = $resourceClassResolver;
        $this->operationMethodResolver = $operationMethodResolver;
        $this->urlGenerator = $urlGenerator;
        $this->title = $title;
        $this->description = $description;
        $this->iriConverter = $iriConverter;
    }

    /**
     * {@inheritdoc}
     */
    public function getApiDocumentation()
    {
        $classes = [];
        $itemOperations = [];
        $itemOperationsDocs = [];
        $properties = [];

        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

            $shortName = $resourceMetadata->getShortName();
            $prefixedShortName = ($iri = $resourceMetadata->getIri()) ? $iri : '#'.$shortName;

            $class = [
                'name' => $shortName,
                'externalDocs' => [
                    'url' => $prefixedShortName,
                ],
            ];

            if ($description = $resourceMetadata->getDescription()) {
                $class = [
                    'name' => $shortName,
                    'description' => $description,
                    'externalDocs' => [
                        'url' => $prefixedShortName,
                    ],
                ];
            }

            $attributes = $resourceMetadata->getAttributes();
            $context = [];

            if (isset($attributes['normalization_context']['groups'])) {
                $context['serializer_groups'] = $attributes['normalization_context']['groups'];
            }

            if (isset($attributes['denormalization_context']['groups'])) {

This code seems to be duplicated across your project.

                $context['serializer_groups'] = isset($context['serializer_groups']) ? array_merge($context['serializer_groups'], $attributes['denormalization_context']['groups']) : $context['serializer_groups'];
            }

            foreach ($this->propertyNameCollectionFactory->create($resourceClass, $context) as $propertyName) {
                $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);

                if ($propertyMetadata->isIdentifier() && !$propertyMetadata->isWritable()) {

The expression $propertyMetadata->isWritable() of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

                    continue;
                }

                $property[$propertyName] = [

$property was never initialized. Although not strictly required by PHP, it is generally a good practice to add $property = array(); before regardless.

                    'type' => $this->getRange($propertyMetadata),
                ];

                $required = [];

                if ($propertyMetadata->isRequired()) {
                    $required = array_merge($required, [$propertyName]);
                }

                if (0 !== count($required)) {
                    $properties[$shortName]['required'] = $required;
                }

                $properties[$shortName]['type'] = 'object';
                $properties[$shortName]['properties'] = $property;

The variable $property does not seem to be defined for all execution paths leading up to this point.

            }

            if ($operations = $resourceMetadata->getItemOperations()) {

This code seems to be duplicated across your project.

                foreach ($operations as $operationName => $itemOperation) {
                    $itemOperations = array_merge($itemOperations, $this->getSwaggerOperation($resourceClass, $resourceMetadata, $operationName, $itemOperation, $prefixedShortName, false));
                }
            }
            $itemOperationsDocs[$this->iriConverter->getIriFromResourceClass($resourceClass)] = $itemOperations;
            $classes[] = $class;
        }

        $doc['swagger'] = '2.0';

$doc was never initialized. Although not strictly required by PHP, it is generally a good practice to add $doc = array(); before regardless.

        if ('' !== $this->title) {
            $doc['info']['title'] = $this->title;
        }

        if ('' !== $this->description) {
            $doc['info']['description'] = $this->description;
        }
        $doc['host'] = $_SERVER['HTTP_HOST'];
        $doc['basePath'] = $this->urlGenerator->generate('api_jsonld_entrypoint');
        $doc['definitions'] = $properties;
        $doc['externalDocs'] = ['description' => 'Find more about api-platform', 'url' => 'docs'];
        $doc['tags'] = $classes;
        $doc['schemes'] = ['http']; // more schema ?
        $doc['paths'] = $itemOperationsDocs;

        return $doc;
    }

    /**
     * Gets and populates if applicable a Swagger operation.
     */
    private function getSwaggerOperation(string $resourceClass, ResourceMetadata $resourceMetadata, string $operationName, array $operation, string $prefixedShortName, bool $collection) : array
    {
        if ($collection) {

This code seems to be duplicated across your project.

            $method = $this->operationMethodResolver->getCollectionOperationMethod($resourceClass, $operationName);
        } else {
            $method = $this->operationMethodResolver->getItemOperationMethod($resourceClass, $operationName);
        }

        $methodSwagger = strtolower($method);
        $swaggerOperation = $operation['swagger_context'] ?? [];
        $shortName = $resourceMetadata->getShortName();
        $swaggerOperation[$methodSwagger] = [];
        $swaggerOperation[$methodSwagger]['tags'] = [$shortName];
        $swaggerOperation[$methodSwagger]['produces'] = ['application/json'];
        $swaggerOperation[$methodSwagger]['consumes'] = $swaggerOperation[$methodSwagger]['produces'];
        switch ($method) {
            case 'GET':

CASE statements must be defined using a colon

                if ($collection) {
                    if (!isset($swaggerOperation[$methodSwagger]['title'])) {

This code seems to be duplicated across your project.

                        $swaggerOperation[$methodSwagger]['summary'] = sprintf('Retrieves the collection of %s resources.', $shortName);
                    }
                } else {
                    if (!isset($swaggerOperation[$methodSwagger]['title'])) {

This code seems to be duplicated across your project.

                        $swaggerOperation[$methodSwagger]['summary'] = sprintf('Retrieves %s resource.', $shortName);
                    }
                    $swaggerOperation[$methodSwagger]['parameters'] = [
                        'name' => 'id',
                        'in' => 'path',
                        'required' => true,
                        'type' => 'integer',
                    ];
                }
            break;

            case 'POST':

CASE statements must be defined using a colon

                if (!isset($swaggerOperation[$methodSwagger]['title'])) {

This code seems to be duplicated across your project.

                    $swaggerOperation[$methodSwagger]['summary'] = sprintf('Creates a %s resource.', $shortName);
                }
                $swaggerOperation[$methodSwagger]['parameters'] = [
                    'in' => 'body',
                    'name' => 'body',
                    'description' => sprintf('%s resource to be added', $shortName),
                    'schema' => [
                        '$ref' => sprintf('%/definitions/%s', $shortName),
                    ],
                ];
                    $swaggerOperation[$methodSwagger]['responses'] = [
                        '400' => 'Valid ID',
                    ];

            break;

            case 'PUT':
                if (!isset($swaggerOperation[$methodSwagger]['title'])) {

This code seems to be duplicated across your project.

                    $swaggerOperation[$methodSwagger]['summary'] = sprintf('Replaces the %s resource.', $shortName);
                }
                break;
        }

        if (!isset($swaggerOperation[$methodSwagger]['returns']) &&

This code seems to be duplicated across your project.

            (
                ('GET' === $method && !$collection) ||
                'POST' === $method ||
                'PUT' === $method
            )
        ) {
            $swaggerOperation[$methodSwagger]['returns'] = $prefixedShortName;
        }

        if (!isset($swaggerOperation[$methodSwagger]['expects']) &&
            ('POST' === $method || 'PUT' === $method)) {
            $swaggerOperation[$methodSwagger]['expects'] = $prefixedShortName;
        }

        ksort($swaggerOperation);

        return $swaggerOperation;
    }

    /**
     * Gets the range of the property.
     *
     * @param PropertyMetadata $propertyMetadata
     *
     * @return string|null
     */
    private function getRange(PropertyMetadata $propertyMetadata)
    {
        $type = $propertyMetadata->getType();
        if (!$type) {
            return;
        }

        if ($type->isCollection() && $collectionType = $type->getCollectionValueType()) {
            $type = $collectionType;
        }

        switch ($type->getBuiltinType()) {
            case 'string':
                return 'string';

            case 'int':
                return 'integer';

            case 'float':
                return 'number';

            case 'double':
                return 'number';

            case 'bool':
                return 'boolean';

            case 'object':

This code seems to be duplicated across your project.

                $className = $type->getClassName();

                if ($className) {
                    if ('DateTime' === $className) {
                        return 'string';
                    }

                    $className = $type->getClassName();
                    if ($this->resourceClassResolver->isResourceClass($className)) {
                        return ['$ref' => sprintf('#/definitions/%s', $this->resourceMetadataFactory->create($className)->getShortName())];
                    }
                }
            break;
            default:
                return 'null';
            break;

break is not strictly necessary here and could be removed.

        }
    }
}