mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-13 04:59:24 +03:00
Keep server_url from Request only in RenderOpenApi
This commit is contained in:
parent
1f29be85f4
commit
181f4b2763
@ -32,9 +32,7 @@ final class DocumentationController
|
|||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
return JsonResponse::fromJsonString(
|
return JsonResponse::fromJsonString(
|
||||||
$this->renderOpenApi->render(RenderOpenApi::JSON, $area, [
|
$this->renderOpenApi->renderFromRequest($request, RenderOpenApi::JSON, $area)
|
||||||
'server_url' => '' !== $request->getBaseUrl() ? $request->getSchemeAndHttpHost().$request->getBaseUrl() : null,
|
|
||||||
])
|
|
||||||
);
|
);
|
||||||
} catch (InvalidArgumentException $e) {
|
} 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));
|
||||||
|
@ -34,8 +34,7 @@ final class SwaggerUiController
|
|||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
$response = new Response(
|
$response = new Response(
|
||||||
$this->renderOpenApi->render(RenderOpenApi::HTML, $area, [
|
$this->renderOpenApi->renderFromRequest($request, RenderOpenApi::HTML, $area, [
|
||||||
'server_url' => '' !== $request->getBaseUrl() ? $request->getSchemeAndHttpHost().$request->getBaseUrl() : null,
|
|
||||||
'assets_mode' => AssetsMode::BUNDLE,
|
'assets_mode' => AssetsMode::BUNDLE,
|
||||||
]),
|
]),
|
||||||
Response::HTTP_OK,
|
Response::HTTP_OK,
|
||||||
|
@ -33,9 +33,7 @@ final class YamlDocumentationController
|
|||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
$response = new Response(
|
$response = new Response(
|
||||||
$this->renderOpenApi->render(RenderOpenApi::YAML, $area, [
|
$this->renderOpenApi->renderFromRequest($request, RenderOpenApi::YAML, $area),
|
||||||
'server_url' => '' !== $request->getBaseUrl() ? $request->getSchemeAndHttpHost().$request->getBaseUrl() : null,
|
|
||||||
]),
|
|
||||||
Response::HTTP_OK,
|
Response::HTTP_OK,
|
||||||
['Content-Type' => 'text/x-yaml']
|
['Content-Type' => 'text/x-yaml']
|
||||||
);
|
);
|
||||||
|
@ -15,7 +15,6 @@ use InvalidArgumentException;
|
|||||||
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;
|
|
||||||
use Twig\Environment;
|
use Twig\Environment;
|
||||||
|
|
||||||
class HtmlOpenApiRenderer implements OpenApiRenderer
|
class HtmlOpenApiRenderer implements OpenApiRenderer
|
||||||
@ -43,7 +42,6 @@ class HtmlOpenApiRenderer implements OpenApiRenderer
|
|||||||
public function render(OpenApi $spec, array $options = []): string
|
public function render(OpenApi $spec, array $options = []): string
|
||||||
{
|
{
|
||||||
$options += [
|
$options += [
|
||||||
'server_url' => null,
|
|
||||||
'assets_mode' => AssetsMode::CDN,
|
'assets_mode' => AssetsMode::CDN,
|
||||||
'swagger_ui_config' => [],
|
'swagger_ui_config' => [],
|
||||||
];
|
];
|
||||||
@ -53,19 +51,10 @@ class HtmlOpenApiRenderer implements OpenApiRenderer
|
|||||||
return $this->twig->render(
|
return $this->twig->render(
|
||||||
'@NelmioApiDoc/SwaggerUi/index.html.twig',
|
'@NelmioApiDoc/SwaggerUi/index.html.twig',
|
||||||
[
|
[
|
||||||
'swagger_data' => ['spec' => $this->createJsonSpec($spec, $options['server_url'])],
|
'swagger_data' => ['spec' => json_decode($spec->toJson(), true)],
|
||||||
'assets_mode' => $options['assets_mode'],
|
'assets_mode' => $options['assets_mode'],
|
||||||
'swagger_ui_config' => $options['swagger_ui_config'],
|
'swagger_ui_config' => $options['swagger_ui_config'],
|
||||||
]
|
]
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function createJsonSpec(OpenApi $spec, $serverUrl)
|
|
||||||
{
|
|
||||||
if ($serverUrl) {
|
|
||||||
$spec->servers = [new Server(['url' => $serverUrl])];
|
|
||||||
}
|
|
||||||
|
|
||||||
return json_decode($spec->toJson(), true);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -14,7 +14,6 @@ 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
|
||||||
{
|
{
|
||||||
@ -26,15 +25,10 @@ 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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -13,7 +13,9 @@ namespace Nelmio\ApiDocBundle\Render;
|
|||||||
|
|
||||||
use InvalidArgumentException;
|
use InvalidArgumentException;
|
||||||
use OpenApi\Annotations\OpenApi;
|
use OpenApi\Annotations\OpenApi;
|
||||||
|
use OpenApi\Annotations\Server;
|
||||||
use Psr\Container\ContainerInterface;
|
use Psr\Container\ContainerInterface;
|
||||||
|
use Symfony\Component\HttpFoundation\Request;
|
||||||
|
|
||||||
class RenderOpenApi
|
class RenderOpenApi
|
||||||
{
|
{
|
||||||
@ -40,6 +42,19 @@ class RenderOpenApi
|
|||||||
return array_keys($this->openApiRenderers);
|
return array_keys($this->openApiRenderers);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function renderFromRequest(Request $request, string $format, $area, array $extraOptions = [])
|
||||||
|
{
|
||||||
|
$options = [];
|
||||||
|
if ('' !== $request->getBaseUrl()) {
|
||||||
|
$options += [
|
||||||
|
'server_url' => $request->getSchemeAndHttpHost().$request->getBaseUrl(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
$options += $extraOptions;
|
||||||
|
|
||||||
|
return $this->render($format, $area, $options);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @throws InvalidArgumentException If the area to dump is not valid
|
* @throws InvalidArgumentException If the area to dump is not valid
|
||||||
*/
|
*/
|
||||||
@ -54,6 +69,10 @@ class RenderOpenApi
|
|||||||
/** @var OpenApi $spec */
|
/** @var OpenApi $spec */
|
||||||
$spec = $this->generatorLocator->get($area)->generate();
|
$spec = $this->generatorLocator->get($area)->generate();
|
||||||
|
|
||||||
|
if (array_key_exists('server_url', $options) && $options['server_url']) {
|
||||||
|
$spec->servers = [new Server(['url' => $options['server_url']])];
|
||||||
|
}
|
||||||
|
|
||||||
return $this->openApiRenderers[$format]->render($spec, $options);
|
return $this->openApiRenderers[$format]->render($spec, $options);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -14,7 +14,6 @@ namespace Nelmio\ApiDocBundle\Render\Yaml;
|
|||||||
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 YamlOpenApiRenderer implements OpenApiRenderer
|
class YamlOpenApiRenderer implements OpenApiRenderer
|
||||||
{
|
{
|
||||||
@ -25,14 +24,6 @@ class YamlOpenApiRenderer implements OpenApiRenderer
|
|||||||
|
|
||||||
public function render(OpenApi $spec, array $options = []): string
|
public function render(OpenApi $spec, array $options = []): string
|
||||||
{
|
{
|
||||||
$options += [
|
|
||||||
'server_url' => null,
|
|
||||||
];
|
|
||||||
|
|
||||||
if ($options['server_url']) {
|
|
||||||
$spec->servers = [new Server(['url' => $options['server_url']])];
|
|
||||||
}
|
|
||||||
|
|
||||||
return $spec->toYaml();
|
return $spec->toYaml();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user