Skip to content

operation openapi property support #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

operation openapi property support #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ea27046
operation openapi attribute support
PawelSuwinski Sep 18, 2024
f46e2ee
Merge branch 'main' into openapi-attr-support
PawelSuwinski Feb 27, 2025
c451ff4
fix
PawelSuwinski Feb 27, 2025
6ff0783
arrow func return typing
PawelSuwinski Feb 27, 2025
3e69994
arrow func return typing
PawelSuwinski Feb 27, 2025
1736be2
arrow func return typing
PawelSuwinski Feb 27, 2025
336fab7
styling
PawelSuwinski Feb 27, 2025
79524b5
anon func return typing
PawelSuwinski Feb 27, 2025
fa0bfaf
no declarative code refacto
PawelSuwinski Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 108 additions & 0 deletions src/AttributeGenerator/ApiPlatformCoreAttributeGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use ApiPlatform\OpenApi\Model\Operation;
use ApiPlatform\OpenApi\Model\Parameter;
use ApiPlatform\OpenApi\Model\Response;
use ApiPlatform\SchemaGenerator\Model\Attribute;
use ApiPlatform\SchemaGenerator\Model\Class_;
use ApiPlatform\SchemaGenerator\Model\Property;
Expand All @@ -39,6 +42,21 @@
*/
final class ApiPlatformCoreAttributeGenerator extends AbstractAttributeGenerator
{
/**
* Hints for not typed array parameters.
*/
private const PRAMETER_TYPE_HINTS = [
Operation::class => [
'responses' => Response::class.'[]',
'parameters' => Parameter::class.'[]',
],
];

/**
* @var array<class-string, array<string, string|null>>
*/
private static array $parameterTypes = [];

public function generateClassAttributes(Class_ $class): array
{
if ($class->hasChild || $class->isEnum()) {
Expand Down Expand Up @@ -85,6 +103,22 @@ public function generateClassAttributes(Class_ $class): array
unset($methodConfig['class']);
}

if (\is_array($methodConfig['openapi'] ?? null)) {
$methodConfig['openapi'] = Literal::new(
'Operation',
self::extractParameters(Operation::class, $methodConfig['openapi'])
);
$class->addUse(new Use_(Operation::class));
array_walk_recursive(
self::$parameterTypes,
function (?string $type) use ($class): void {
if (null !== $type) {
$class->addUse(new Use_(str_replace('[]', '', $type)));
}
}
);
}

$arguments['operations'][] = new Literal(\sprintf('new %s(...?:)',
$operationMetadataClass,
), [$methodConfig ?? []]);
Expand All @@ -95,6 +129,80 @@ public function generateClassAttributes(Class_ $class): array
return [new Attribute('ApiResource', $arguments)];
}

/**
* @param class-string $type
* @param mixed[] $values
*
* @return mixed[]
*/
private static function extractParameters(string $type, array $values): array
{
$types = self::$parameterTypes[$type] ??=
(static::PRAMETER_TYPE_HINTS[$type] ?? []) + array_reduce(
(new \ReflectionClass($type))->getConstructor()?->getParameters() ?? [],
static fn (array $types, \ReflectionParameter $refl): array => $types + [
$refl->getName() => $refl->getType() instanceof \ReflectionNamedType
&& !$refl->getType()->isBuiltin()
? $refl->getType()->getName()
: null,
],
[]
);
if (isset(self::$parameterTypes[$type])) {
$types = self::$parameterTypes[$type];
} else {
$types = static::PRAMETER_TYPE_HINTS[$type] ?? [];
$parameterRefls = (new \ReflectionClass($type))
->getConstructor()
?->getParameters() ?? [];
foreach ($parameterRefls as $refl) {
$paramName = $refl->getName();
if (\array_key_exists($paramName, $types)) {
continue;
}
$paramType = $refl->getType();
if ($paramType instanceof \ReflectionNamedType && !$paramType->isBuiltin()) {
$types[$paramName] = $paramType->getName();
} else {
$types[$paramName] = null;
}
}
self::$parameterTypes[$type] = $types;
}

$parameters = array_intersect_key($values, $types);
foreach ($parameters as $name => $parameter) {
$type = $types[$name];
if (null === $type || !\is_array($parameter)) {
continue;
}
$isArrayType = str_ends_with($type, '[]');
/**
* @var class-string
*/
$type = $isArrayType ? substr($type, 0, -2) : $type;
$shortName = (new \ReflectionClass($type))->getShortName();
if ($isArrayType) {
$parameters[$name] = [];
foreach ($parameter as $key => $values) {
$parameters[$name][$key] = Literal::new(
$shortName,
self::extractParameters($type, $values)
);
}
} else {
$parameters[$name] = Literal::new(
$shortName,
\ArrayObject::class === $type
? [$parameter]
: self::extractParameters($type, $parameter)
);
}
}

return $parameters;
}

/**
* Verifies that the operations' config is valid.
*
Expand Down
139 changes: 139 additions & 0 deletions tests/Command/GenerateCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,6 +538,145 @@ class Page extends Object_
self::assertFalse($this->fs->exists("$outputDir/App/Entity/Travel.php"));
}

public function testOpenapiOperationProperty(): void
{
$outputDir = __DIR__.'/../../build/openapi-operation-property';
$config = __DIR__.'/../config/openapi-operation-property.yaml';

$this->fs->mkdir($outputDir);

$commandTester = new CommandTester(new GenerateCommand());
$this->assertEquals(0, $commandTester->execute(['output' => $outputDir, 'config' => $config]));
$source = file_get_contents("$outputDir/App/Entity/Saml.php");

$this->assertStringContainsString(<<<'PHP'
use ApiPlatform\OpenApi\Model\Operation;
use ApiPlatform\OpenApi\Model\Parameter;
use ApiPlatform\OpenApi\Model\RequestBody;
use ApiPlatform\OpenApi\Model\Response;
PHP
, $source);

$this->assertStringContainsString(<<<'PHP'
#[ApiResource(
shortName: 'Saml',
types: ['https://schema.org/Thing'],
operations: [
new Get(
name: 'login',
uriTemplate: '/saml/{id}/login',
controller: 'App\Controller\SamlController::login',
openapi: new Operation(
tags: ['Auth'],
summary: 'SAML authentication.',
description: 'SAML authentication.',
responses: [
302 => new Response(
description: 'Initialization successful.',
headers: new \ArrayObject([
'Location' => [
'required' => true,
'description' => 'SAML login page redirection.',
'schema' => ['type' => 'string', 'format' => 'url'],
],
]),
),
403 => new Response(description: 'SAML disabled.'),
404 => new Response(description: 'SAML not found.'),
],
),
),
new Post(
name: 'acs',
uriTemplate: '/saml/{id}/acs',
controller: 'App\Controller\SamlController::acs',
inputFormats: ['urlencoded' => ['application/x-www-form-urlencoded']],
openapi: new Operation(
tags: ['Auth'],
summary: 'SAML ACS.',
description: 'SAML ACS.',
responses: [
302 => new Response(
description: 'Authentication successful.',
headers: new \ArrayObject([
'Location' => [
'required' => true,
'description' => 'Redirection page.',
'schema' => ['type' => 'string', 'format' => 'url'],
],
]),
),
401 => new Response(description: 'Authentication failed.'),
403 => new Response(description: 'SAML disabled.'),
404 => new Response(description: 'SAML not found.'),
],
requestBody: new RequestBody(
required: true,
content: new \ArrayObject([
'application/x-www-form-urlencoded' => [
'schema' => [
'type' => 'object',
'properties' => ['SAMLResponse' => ['type' => 'string', 'description' => 'SAML login response.']],
],
'required' => ['SAMLResponse'],
],
]),
),
),
),
new Get(
name: 'logout',
uriTemplate: '/saml/{id}/logout',
controller: 'App\Controller\SamlController::logout',
openapi: new Operation(
tags: ['Auth'],
summary: 'SAML logout.',
description: 'SAML logout.',
parameters: [
new Parameter(
name: 'SAMLRequest',
in: 'query',
schema: ['type' => 'string'],
required: true,
description: 'SAML logout request.',
),
new Parameter(
name: 'RelayState',
in: 'query',
schema: ['type' => 'string'],
required: false,
description: 'SAML logout response redirect URL.',
),
new Parameter(
name: 'Signature',
in: 'query',
schema: ['type' => 'string'],
required: false,
description: 'SAML signature.',
),
],
responses: [
302 => new Response(
description: 'Logout successful.',
headers: new \ArrayObject([
'Location' => [
'required' => true,
'description' => 'SAML logout response redirect URL.',
'schema' => ['type' => 'string', 'format' => 'url'],
],
]),
),
403 => new Response(description: 'Logout failed.'),
404 => new Response(description: 'SAML not found.'),
],
),
),
],
)]
PHP
, $source);
}

public function testGenerationWithoutConfigFileQuestion(): void
{
// No config file is given.
Expand Down
106 changes: 106 additions & 0 deletions tests/config/openapi-operation-property.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
types:
Saml:
operations:
login:
class: Get
name: "login"
uriTemplate: "/saml/{id}/login"
controller: "App\\Controller\\SamlController::login"
openapi:
tags: ["Auth"]
summary: "SAML authentication."
description: "SAML authentication."
responses:
302:
description: "Initialization successful."
headers:
Location:
required: true
description: "SAML login page redirection."
schema:
type: "string"
format: "url"
403: { description: "SAML disabled." }
404: { description: "SAML not found." }
acs:
class: Post
name: "acs"
uriTemplate: "/saml/{id}/acs"
controller: "App\\Controller\\SamlController::acs"
inputFormats:
urlencoded: ['application/x-www-form-urlencoded']
openapi:
tags: ["Auth"]
summary: "SAML ACS."
description: "SAML ACS."
responses:
302:
description: "Authentication successful."
headers:
Location:
required: true
description: "Redirection page."
schema:
type: "string"
format: "url"
401: { description: "Authentication failed."}
403: { description: "SAML disabled." }
404: { description: "SAML not found." }
requestBody:
required: true
content:
"application/x-www-form-urlencoded":
schema:
type: object
properties:
SAMLResponse:
type: string
description: "SAML login response."
required: ["SAMLResponse"]
logout:
class: Get
name: "logout"
uriTemplate: "/saml/{id}/logout"
controller: "App\\Controller\\SamlController::logout"
openapi:
tags: ["Auth"]
summary: "SAML logout."
description: "SAML logout."
parameters:
- name: "SAMLRequest"
in: "query"
schema: { type: "string" }
required: true
description: "SAML logout request."
- name: "RelayState"
in: "query"
schema: { type: "string" }
required: false
description: "SAML logout response redirect URL."
- name: "Signature"
in: "query"
schema: { type: "string" }
required: false
description: "SAML signature."
responses:
302:
description: "Logout successful."
headers:
Location:
required: true
description: "SAML logout response redirect URL."
schema:
type: "string"
format: "url"

403: { description: "Logout failed." }
404: { description: "SAML not found." }
attributes:
ApiResource:
shortName: "Saml"
properties:
name:
nullable: false
attributes:
ApiProperty:
iris: [ "https://schema.org/name" ]