RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

Refactor Existing Ref parsing in RouteMetadataDescriber

Browse Source
This commit is contained in:
cyberemissary 2020-01-10 11:53:34 -05:00
parent 3710e95d26
commit 94f7715f68
3 changed files with 61 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
RouteDescriber/RouteMetadataDescriber.php
View File

@ -11,7 +11,10 @@
namespace Nelmio\ApiDocBundle\RouteDescriber;
use EXSyst\Component\Swagger\Operation;
use EXSyst\Component\Swagger\Parameter;
use EXSyst\Component\Swagger\Swagger;
use LogicException;
use Symfony\Component\Routing\Route;
/**
@ -28,29 +31,7 @@ final class RouteMetadataDescriber implements RouteDescriberInterface
$requirements = $route->getRequirements();
$compiledRoute = $route->compile();
$globalParams = $api->getParameters();
$existingParams = [];
foreach ($operation->getParameters() as $id => $parameter) {
$ref = $parameter->getRef();
if (null === $ref) {
$existingParams[$id] = true;
// we only concern ourselves with '$ref' parameters
continue;
}
$ref = \mb_substr($ref, 13); // trim the '#/parameters/' part of ref
if (!isset($globalParams[$ref])) {
// this shouldn't happen, so just ignore here
continue;
}
$refParameter = $globalParams[$ref];
// param ids are in form {name}/{in}
$existingParams[\sprintf('%s/%s', $refParameter->getName(), $refParameter->getIn())] = true;
}
$existingParams = $this->getRefParams($api, $operation);
// Don't include host requirements
foreach ($compiledRoute->getPathVariables() as $pathVariable) {
@ -58,8 +39,14 @@ final class RouteMetadataDescriber implements RouteDescriberInterface
continue;
}
if (isset($existingParams[$pathVariable.'/path'])) {
continue; // ignore this param, it is already defined
$paramId = $pathVariable.'/path';
$parameter = $existingParams[$paramId] ?? null;
if (null !== $parameter) {
if (!$parameter->getRequired()) {
throw new LogicException(\sprintf('Global parameter "%s" is used as part of route "%s" and must be set as "required"', $pathVariable, $route->getPath()));
}
continue;
}
$parameter = $operation->getParameters()->get($pathVariable, 'path');
@ -75,4 +62,37 @@ final class RouteMetadataDescriber implements RouteDescriberInterface
}
}
}
/**
* The '$ref' parameters need special handling, since their objects are missing 'name' and 'in'.
*
* @return Parameter[] existing $ref parameters
*/
private function getRefParams(Swagger $api, Operation $operation): array
{
/** @var Parameter[] $globalParams */
$globalParams = $api->getParameters();
$existingParams = [];
foreach ($operation->getParameters() as $id => $parameter) {
$ref = $parameter->getRef();
if (null === $ref) {
// we only concern ourselves with '$ref' parameters, so continue the loop
continue;
}
$ref = \mb_substr($ref, 13); // trim the '#/parameters/' part of ref
if (!isset($globalParams[$ref])) {
// this shouldn't happen during proper configs, but in case of bad config, just ignore it here
continue;
}
$refParameter = $globalParams[$ref];
// param ids are in form {name}/{in}
$existingParams[\sprintf('%s/%s', $refParameter->getName(), $refParameter->getIn())] = $refParameter;
}
return $existingParams;
}
}

12
Tests/Functional/Controller/TestController.php
View File

@ -29,4 +29,16 @@ class TestController
public function testAction()
{
}
/**
* @SWG\Parameter(ref="#/parameters/test"),
* @SWG\Response(
* response="200",
* description="Test Ref"
* )
* @Route("/test/{id}", methods={"GET"})
*/
public function testRefAction()
{
}
}

4
Tests/Functional/SwaggerUiTest.php
View File

@ -59,6 +59,10 @@ class SwaggerUiTest extends WebTestCase
'/test/test/' => ['get' => [
'responses' => ['200' => ['description' => 'Test']],
]],
'/test/test/{id}' => ['get' => [
'responses' => ['200' => ['description' => 'Test Ref']],
'parameters' => [['$ref' => '#/parameters/test']],
]],
];
$expected['definitions'] = [
'Dummy' => $expected['definitions']['Dummy'],