src/OpenApi/JwtDecorator.php line 23

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\OpenApi;
  7. use ApiPlatform\Core\OpenApi\Model;
  8. use ApiPlatform\Core\OpenApi\OpenApi;
  9. use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
  10. use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
  12. final class JwtDecorator implements OpenApiFactoryInterface
  13. {
  14.     private string $apiRoutePrefix;
  16.     public function __construct(
  17.         private OpenApiFactoryInterface $decorated,
  18.         private ParameterBagInterface $parameterBag,
  19.     ) {
  20.         $this->apiRoutePrefix = $this->parameterBag->get('api.route.prefix');
  21.     }
  23.     public function __invoke(array $context = []): OpenApi
  24.     {
  25.         $openApi = ($this->decorated)($context);
  26.         $schemas = $openApi->getComponents()->getSchemas();
  28.         $schemas['Token'] = new \ArrayObject([
  29.             'type' => 'object',
  30.             'properties' => [
  31.                 'token' => [
  32.                     'type' => 'string',
  33.                     'readOnly' => true,
  34.                 ],
  35.                 'refresh_token' => [
  36.                     'type' => 'string',
  37.                     'readOnly' => true,
  38.                 ],
  39.             ],
  40.         ]);
  41.         $schemas['Credentials'] = new \ArrayObject([
  42.             'type' => 'object',
  43.             'properties' => [
  44.                 'username' => [
  45.                     'type' => 'string',
  46.                     'example' => 'johndoe@example.com',
  47.                 ],
  48.                 'password' => [
  49.                     'type' => 'string',
  50.                     'example' => 'password',
  51.                 ],
  52.                 'franchiseId' => [
  53.                     'type' => 'integer',
  54.                     'example' => 0,
  55.                 ],
  56.             ],
  57.         ]);
  59.         $pathItem = new Model\PathItem(
  60.             ref: 'JWT Token',
  61.             post: new Model\Operation(
  62.                 operationId: 'postCredentialsItem',
  63.                 tags: ['Token'],
  64.                 responses: [
  65.                     '200' => [
  66.                         'description' => 'Get JWT token',
  67.                         'content' => [
  68.                             'application/json' => [
  69.                                 'schema' => [
  70.                                     '$ref' => '#/components/schemas/Token',
  71.                                 ],
  72.                             ],
  73.                         ],
  74.                     ],
  75.                 ],
  76.                 summary: 'Get JWT token to login.',
  77.                 requestBody: new Model\RequestBody(
  78.                     description: 'Generate new JWT Token',
  79.                     content: new \ArrayObject([
  80.                         'application/json' => [
  81.                             'schema' => [
  82.                                 '$ref' => '#/components/schemas/Credentials',
  83.                             ],
  84.                         ],
  85.                     ]),
  86.                 ),
  87.             ),
  88.         );
  89.         $openApi->getPaths()->addPath($this->apiRoutePrefix . '/login', $pathItem);
  91.         $schemas['RefreshCredentials'] = new \ArrayObject([
  92.             'type' => 'object',
  93.             'properties' => [
  94.                 'refresh_token' => [
  95.                     'type' => 'string',
  96.                     'example' => 'refresh_token',
  97.                 ],
  98.                 'franchiseId' => [
  99.                     'type' => 'integer',
  100.                     'example' => 0,
  101.                 ],
  102.             ],
  103.         ]);
  105.         $refreshPathItem = new Model\PathItem(
  106.             ref: 'JWT Token Refresh',
  107.             post: new Model\Operation(
  108.                 operationId: 'postRefreshTokenItem',
  109.                 tags: ['Token'],
  110.                 responses: [
  111.                     '200' => [
  112.                         'description' => 'Get refreshed JWT token',
  113.                         'content' => [
  114.                             'application/json' => [
  115.                                 'schema' => [
  116.                                     '$ref' => '#/components/schemas/Token',
  117.                                 ],
  118.                             ],
  119.                         ],
  120.                     ],
  121.                 ],
  122.                 summary: 'Get refreshed JWT token using a refresh token.',
  123.                 requestBody: new Model\RequestBody(
  124.                     description: 'Refresh JWT Token',
  125.                     content: new \ArrayObject([
  126.                         'application/json' => [
  127.                             'schema' => [
  128.                                 '$ref' => '#/components/schemas/RefreshCredentials',
  129.                             ],
  130.                         ],
  131.                     ]),
  132.                 ),
  133.             ),
  134.         );
  135.         $openApi->getPaths()->addPath($this->apiRoutePrefix . '/token/refresh', $refreshPathItem);
  137.         return $openApi;
  138.     }
  139. }