RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-03-12 10:36:09 +03:00
Code Issues Projects Releases Wiki Activity

Use json renderer in controller

Browse Source
This commit is contained in:
Zdeněk Drahoš 2021-07-29 12:01:54 +02:00
parent 1b9be28ad6
commit 1f29be85f4
3 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Controller/DocumentationController.php
View File

@ -11,35 +11,33 @@
namespace Nelmio\ApiDocBundle\Controller; namespace Nelmio\ApiDocBundle\Controller;
use OpenApi\Annotations\OpenApi; use Nelmio\ApiDocBundle\Render\RenderOpenApi;
use OpenApi\Annotations\Server;
use Psr\Container\ContainerInterface;
use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException; use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
final class DocumentationController final class DocumentationController
{ {
private $generatorLocator; /**
* @var RenderOpenApi
*/
private $renderOpenApi;
public function __construct(ContainerInterface $generatorLocator) public function __construct(RenderOpenApi $renderOpenApi)
{ {
$this->generatorLocator = $generatorLocator; $this->renderOpenApi = $renderOpenApi;
} }
public function __invoke(Request $request, $area = 'default') public function __invoke(Request $request, $area = 'default')
{ {
if (!$this->generatorLocator->has($area)) { try {
return JsonResponse::fromJsonString(
$this->renderOpenApi->render(RenderOpenApi::JSON, $area, [
'server_url' => '' !== $request->getBaseUrl() ? $request->getSchemeAndHttpHost().$request->getBaseUrl() : null,
])
);
} catch (InvalidArgumentException $e) {
throw new BadRequestHttpException(sprintf('Area "%s" is not supported as it isn\'t defined in config.', $area)); throw new BadRequestHttpException(sprintf('Area "%s" is not supported as it isn\'t defined in config.', $area));
} }
/** @var OpenApi $spec */
$spec = $this->generatorLocator->get($area)->generate();
if ('' !== $request->getBaseUrl()) {
$spec->servers = [new Server(['url' => $request->getSchemeAndHttpHost().$request->getBaseUrl()])];
}
return new JsonResponse($spec);
} }
} }

6
Render/Json/JsonOpenApiRenderer.php
View File

@ -14,6 +14,7 @@ namespace Nelmio\ApiDocBundle\Render\Json;
use Nelmio\ApiDocBundle\Render\OpenApiRenderer; use Nelmio\ApiDocBundle\Render\OpenApiRenderer;
use Nelmio\ApiDocBundle\Render\RenderOpenApi; use Nelmio\ApiDocBundle\Render\RenderOpenApi;
use OpenApi\Annotations\OpenApi; use OpenApi\Annotations\OpenApi;
use OpenApi\Annotations\Server;
class JsonOpenApiRenderer implements OpenApiRenderer class JsonOpenApiRenderer implements OpenApiRenderer
{ {
@ -25,10 +26,15 @@ class JsonOpenApiRenderer implements OpenApiRenderer
public function render(OpenApi $spec, array $options = []): string public function render(OpenApi $spec, array $options = []): string
{ {
$options += [ $options += [
'server_url' => null,
'no-pretty' => false, 'no-pretty' => false,
]; ];
$flags = $options['no-pretty'] ? 0 : JSON_PRETTY_PRINT; $flags = $options['no-pretty'] ? 0 : JSON_PRETTY_PRINT;
if ($options['server_url']) {
$spec->servers = [new Server(['url' => $options['server_url']])];
}
return json_encode($spec, $flags); return json_encode($spec, $flags);
} }
} }

2
Resources/config/services.xml
View File

@ -18,7 +18,7 @@
<service id="nelmio_api_doc.controller.swagger" alias="nelmio_api_doc.controller.swagger_json" public="true" /> <service id="nelmio_api_doc.controller.swagger" alias="nelmio_api_doc.controller.swagger_json" public="true" />
<service id="nelmio_api_doc.controller.swagger_json" class="Nelmio\ApiDocBundle\Controller\DocumentationController" public="true"> <service id="nelmio_api_doc.controller.swagger_json" class="Nelmio\ApiDocBundle\Controller\DocumentationController" public="true">
<argument type="service" id="nelmio_api_doc.generator_locator" /> <argument type="service" id="nelmio_api_doc.render_docs" />
</service> </service>
<service id="nelmio_api_doc.controller.swagger_yaml" class="Nelmio\ApiDocBundle\Controller\YamlDocumentationController" public="true"> <service id="nelmio_api_doc.controller.swagger_yaml" class="Nelmio\ApiDocBundle\Controller\YamlDocumentationController" public="true">