Update Swagger DocumentationNormalizer for AWS API-Gateway #1697
Conversation
| @@ -609,7 +605,7 @@ private function computeDoc(Documentation $documentation, \ArrayObject $definiti | |||
| { | |||
| $doc = [ | |||
| 'swagger' => self::SWAGGER_VERSION, | |||
| 'basePath' => $context['base_url'] ?? '/', | |||
There was a problem hiding this comment.
In my case, basePath is empty, which is not valid according to Swagger 2.0
There was a problem hiding this comment.
($context['base_url'] ?? '/') ?: '/'?
There was a problem hiding this comment.
empty checks if the variable is defined and not empty:
There was a problem hiding this comment.
(it's the line below this modification. GitHub shows a removal, but it's a line edit)
There was a problem hiding this comment.
(I know for empty, it's because my version is shorter, but nitpicking, keep it as is)
| @@ -155,7 +155,7 @@ public function normalize($object, $format = null, array $context = []) | |||
|
|
|||
| if ($parameters = $this->getFiltersParameters($resourceClass, $operationName, $subResourceMetadata, $definitions, $serializerContext)) { | |||
| foreach ($parameters as $parameter) { | |||
| if (!\in_array($parameter['name'], $parametersMemory, true)) { | |||
| if (!\in_array($parameter['name'], $parametersMemory, true) && preg_match('/^[a-zA-Z0-9._$-]+$/', $parameter['name'])) { | |||
There was a problem hiding this comment.
This regex really sucks, it doesn't allow array filters like ?foo[]=bar, but this pattern is required by API Gateway on Swagger doc import
| @@ -511,10 +511,6 @@ private function getPropertySchema(PropertyMetadata $propertyMetadata, \ArrayObj | |||
| { | |||
| $propertySchema = new \ArrayObject($propertyMetadata->getAttributes()['swagger_context'] ?? []); | |||
|
|
|||
| if (false === $propertyMetadata->isWritable()) { | |||
| $propertySchema['readOnly'] = true; | |||
There was a problem hiding this comment.
This shouldn't be removed, but API Gateway doesn't support it:
The readOnly field is not supported.
| @@ -690,6 +686,9 @@ private function getFiltersParameters(string $resourceClass, string $operationNa | |||
| } | |||
|
|
|||
| foreach ($filter->getDescription($resourceClass) as $name => $data) { | |||
| if (!preg_match('/^[a-zA-Z0-9._$-]+$/', $name)) { | |||
There was a problem hiding this comment.
Same: this regex really sucks, it doesn't allow array filters like ?foo[]=bar, but this pattern is required by API Gateway on Swagger doc import
|
Other idea: can't we create a decorator that will remove all things that API Gateway doesn't allow, create a command like our |
|
@dunglas I've updated this PR to enabled API Gateway support only if |
| @@ -66,6 +67,7 @@ | |||
| private $paginationPageParameterName; | |||
| private $clientItemsPerPage; | |||
| private $itemsPerPageParameterName; | |||
| private $apiGateway = false; | |||
There was a problem hiding this comment.
Can't we do it without introducing a state?
There was a problem hiding this comment.
I tried to, but final code would have been much more complex
vincentchalamon
changed the title
vincentchalamon
changed the title
vincentchalamon
force-pushed
the
2.1
branch
3 times, most recently
from
09f8f52
to
e45a292
Compare
| @@ -42,7 +42,11 @@ public function __construct(ResourceNameCollectionFactoryInterface $resourceName | |||
| public function __invoke(Request $request = null): Documentation | |||
| { | |||
| if (null !== $request) { | |||
| $request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + ['base_url' => $request->getBaseUrl()]); | |||
| $context = ['base_url' => $request->getBaseUrl()]; | |||
| if ($request->query->has('api_gateway') && true === $request->query->getBoolean('api_gateway')) { | |||
There was a problem hiding this comment.
Can be simplified in if ($request->query->getBoolean('api_gateway', false))
| use Symfony\Component\Serializer\Normalizer\NormalizerInterface; | ||
|
|
||
| /** | ||
| * Override Swagger documentation for API Gateway. |
There was a problem hiding this comment.
* Removes features unsupported by Amazon API Gateway.
*
* @see <the-relevant-amazon-docs>
|
|
||
| use Symfony\Component\Serializer\Normalizer\NormalizerInterface; | ||
|
|
||
| /** |
There was a problem hiding this comment.
Can you mark this class as @internal, so we'll be able to remove it when Amazon will improve its Docker support.
|
Thanks @vincentchalamon |
This PR represents the changes required on the
/docs.jsonSwagger doc to be valid to AWS API Gateway.