13814792797

Committed 12 Mar 2025 03:09PM UTC coverage: 5.889% (-1.4%) from 7.289%

Build # 13814792797

Build Type

Pull #7012

github

Committed by

web-flow

Commit Message

Merge 199d44919 into 284937039

Pull Request Pull Request #7012: doc: comment typo in ApiResource.php

Run Details

10048 of 170615 relevant lines covered (5.89%)

5.17 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.83

/src/Symfony/Bundle/SwaggerUi/SwaggerUiProvider.php

<?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.
 */

declare(strict_types=1);

namespace ApiPlatform\Symfony\Bundle\SwaggerUi;

use ApiPlatform\Documentation\Documentation;
use ApiPlatform\Documentation\Entrypoint;
use ApiPlatform\Metadata\Error;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\OpenApi\OpenApi;
use ApiPlatform\State\ProviderInterface;

/**
 * When an HTML request is sent we provide a swagger ui documentation.
 *
 * @internal
 */
final class SwaggerUiProvider implements ProviderInterface
{
    public function __construct(private readonly ProviderInterface $decorated, private readonly OpenApiFactoryInterface $openApiFactory)
    {
    }

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {
        // We went through the DocumentationAction
        if (OpenApi::class === $operation->getClass()) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        if (
            !($operation instanceof HttpOperation)
            || !($request = $context['request'] ?? null)
            || 'html' !== $request->getRequestFormat()
            || true === ($operation->getExtraProperties()['_api_disable_swagger_provider'] ?? false)
        ) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        if (!$request->attributes->has('_api_requested_operation')) {
            $request->attributes->set('_api_requested_operation', $operation);
        }

        // We need to call our operation provider just in case it fails
        // when it fails we'll get an Error and we'll fix the status accordingly
        // @see features/main/content_negotiation.feature:119
        // When requesting DocumentationAction or EntrypointAction with Accept: text/html we render SwaggerUi
        if (!$operation instanceof Error && !\in_array($operation->getClass(), [Documentation::class, Entrypoint::class], true)) {
            $this->decorated->provide($operation, $uriVariables, $context);
        }

        // This should render only when an error occured
        $swaggerUiOperation = new Get(
            class: OpenApi::class,
            processor: 'api_platform.swagger_ui.processor',
            validate: false,
            read: false,
            write: true, // force write so that our processor gets called
            status: $operation->getStatus()
        );

        // save our operation
        $request->attributes->set('_api_operation', $swaggerUiOperation);
        $data = $this->openApiFactory->__invoke(['base_url' => $request->getBaseUrl() ?: '/']);
        $request->attributes->set('data', $data);

        return $data;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Symfony\Bundle\SwaggerUi;
15
16	use ApiPlatform\Documentation\Documentation;
17	use ApiPlatform\Documentation\Entrypoint;
18	use ApiPlatform\Metadata\Error;
19	use ApiPlatform\Metadata\Get;
20	use ApiPlatform\Metadata\HttpOperation;
21	use ApiPlatform\Metadata\Operation;
22	use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
23	use ApiPlatform\OpenApi\OpenApi;
24	use ApiPlatform\State\ProviderInterface;
25
26	/**
27	* When an HTML request is sent we provide a swagger ui documentation.
28	*
29	* @internal
30	*/
31	final class SwaggerUiProvider implements ProviderInterface
32	{
33	public function __construct(private readonly ProviderInterface $decorated, private readonly OpenApiFactoryInterface $openApiFactory)
34	{
35	}	360✔
36
37	public function provide(Operation $operation, array $uriVariables = [], array $context = []): object\|array\|null
38	{
39	// We went through the DocumentationAction
40	if (OpenApi::class === $operation->getClass()) {	351✔
41	return $this->decorated->provide($operation, $uriVariables, $context);	3✔
42	}
43
44	if (
45	!($operation instanceof HttpOperation)	348✔
46	\|\| !($request = $context['request'] ?? null)	348✔
47	\|\| 'html' !== $request->getRequestFormat()	348✔
48	\|\| true === ($operation->getExtraProperties()['_api_disable_swagger_provider'] ?? false)	348✔
49	) {
50	return $this->decorated->provide($operation, $uriVariables, $context);	339✔
51	}
52
53	if (!$request->attributes->has('_api_requested_operation')) {	9✔
54	$request->attributes->set('_api_requested_operation', $operation);	9✔
55	}
56
57	// We need to call our operation provider just in case it fails
58	// when it fails we'll get an Error and we'll fix the status accordingly
59	// @see features/main/content_negotiation.feature:119
60	// When requesting DocumentationAction or EntrypointAction with Accept: text/html we render SwaggerUi
61	if (!$operation instanceof Error && !\in_array($operation->getClass(), [Documentation::class, Entrypoint::class], true)) {	9✔
62	$this->decorated->provide($operation, $uriVariables, $context);	×
63	}
64
65	// This should render only when an error occured
66	$swaggerUiOperation = new Get(	9✔
67	class: OpenApi::class,	9✔
68	processor: 'api_platform.swagger_ui.processor',	9✔
69	validate: false,	9✔
70	read: false,	9✔
71	write: true, // force write so that our processor gets called	9✔
72	status: $operation->getStatus()	9✔
73	);	9✔
74
75	// save our operation
76	$request->attributes->set('_api_operation', $swaggerUiOperation);	9✔
77	$data = $this->openApiFactory->__invoke(['base_url' => $request->getBaseUrl() ?: '/']);	9✔
78	$request->attributes->set('data', $data);	9✔
79
80	return $data;	9✔
81	}
82	}

api-platform / core / 13814792797

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous