EV-267: POC on DTO and api platform

Author: cableman

.env

@@ -22,6 +22,16 @@ APP_ENV=dev
 APP_SECRET=01324d73757787ffeba5f2f76cec1a28
 ###< symfony/framework-bundle ###
 
+###> app ###
+APP_PATH_PREFIX=/api/v2
+###< app ###
+
+###> INDEX ###
+INDEX_URL=http://elasticsearch:9200
+INDEX_EVENTS_ALIAS=events
+INDEX_ORGANIZATION_ALIAS=organization
+###< INDEX ###
+
 ###> doctrine/doctrine-bundle ###
 # Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
 # IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml

compose.override.yaml

@@ -11,6 +11,16 @@ api_platform:
         jsonopenapi: ['application/vnd.openapi+json']
         html: ['text/html']
 
+    mapping:
+        paths:
+            - '%kernel.project_dir%/src/Api/Dto'
+
+    doctrine:
+        enabled: false
+
+    elasticsearch:
+        hosts: ['%env(INDEXING_URL)%']
+
     defaults:
         stateless: true
         cache_headers:

config/packages/api_platform.yaml

@@ -11,6 +11,10 @@ services:
         autowire: true      # Automatically injects dependencies in your services.
         autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
 
+#        bind:
+#            # Bound services
+#            Elasticsearch\Client: '@api_platform.elasticsearch.client'
+
     # makes classes in src/ available to be used as services
     # this creates a service per class whose id is the fully-qualified class name
     App\:

config/services.yaml

@@ -0,0 +1,39 @@
+version: "3"
+
+services:
+  phpfpm:
+    depends_on:
+      - elasticsearch
+      - rabbit
+
+  rabbit:
+    image: rabbitmq:3.12.4-management-alpine
+    networks:
+      - app
+      - frontend
+    ports:
+      - "15672"
+    environment:
+      - RABBITMQ_DEFAULT_USER=user
+      - RABBITMQ_DEFAULT_PASS=password
+      - RABBITMQ_ERLANG_COOKIE='d53f319cd7376f8f840aaf9889f315ab
+
+  elasticsearch:
+    image: elasticsearch:8.10.2
+    networks:
+      - app
+      - frontend
+    ports:
+      - "9200"
+    deploy:
+      resources:
+        limits:
+          memory: 4096M
+        reservations:
+          memory: 4096M
+    volumes:
+      - ./.docker/data/elasticsearch:/usr/share/elasticsearch/data
+    environment:
+      - discovery.type=single-node
+      - xpack.security.enabled=false
+

docker-compose.override.yml

@@ -0,0 +1,47 @@
+<?php
+
+namespace App\Api\Dto;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use App\Api\State\EventRepresentationProvider;
+
+#[ApiResource(operations: [
+    new Get(
+        openapiContext: [
+            'summary' => 'Get single event base on identifier',
+            'parameters' => [
+                [
+                    'name' => 'id',
+                    'in' => 'path',
+                    'required' => true,
+                    'schema' => [
+                        'type' => 'integer',
+                    ],
+                ],
+            ],
+        ],
+        output: EventRepresentationProvider::class,
+        provider: EventRepresentationProvider::class,
+    ),
+])]
+class Event
+{
+    #[ApiProperty(
+        identifier: true,
+    )]
+    private int $id;
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function setId(int $id): static
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+}

src/Api/Dto/Event.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @file
+ * Cover item data provider.
+ *
+ * @see https://api-platform.com/docs/core/data-providers/
+ */
+
+namespace App\Api\State;
+
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ProviderInterface;
+use App\Api\Dto\Event;
+
+/**
+ * Class CoverItemDataProvider.
+ */
+final class EventRepresentationProvider implements ProviderInterface
+{
+    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
+    {
+        $event = new Event();
+        $event->setId(1);
+
+        return $event;
+    }
+}