### Create React App and Install API Platform Admin (Bash)

Source: https://api-platform.com/docs/v2.7/admin/getting-started

This snippet shows how to create a new React application using Create React App and then install the @api-platform/admin library. It requires Node.js and npm to be installed.

```bash
npm init react-app my-admin
cd my-admin
npm install @api-platform/admin
```

--------------------------------

### Install Schema Generator (Composer)

Source: https://api-platform.com/docs/v2.7/schema-generator/getting-started

Installs the Schema Generator as a development dependency in an existing project using Composer. This is an alternative to the Docker-based installation.

```bash
composer require --dev api-platform/schema-generator

```

--------------------------------

### Install React App and Dependencies

Source: https://api-platform.com/docs/v2.7/create-client/react

This snippet shows how to bootstrap a new React application using Create React App with TypeScript, install necessary routing and form handling libraries, and optionally add styling libraries like Bootstrap and Font Awesome. Finally, it starts the development server.

```bash
npm init react-app --template typescript my-app
cd my-app

npm install react-router-dom react-hook-form

npm install bootstrap font-awesome

npm run start
```

--------------------------------

### Install Schema Generator (Docker)

Source: https://api-platform.com/docs/v2.7/schema-generator/getting-started

Installs the Schema Generator as a development dependency for the API Platform distribution using Docker. This command executes the generator within the PHP container.

```bash
docker compose exec php \
    vendor/bin/schema

```

--------------------------------

### Install Google Cloud SDK

Source: https://api-platform.com/docs/v2.7/deployment/kubernetes

Installs the Google Cloud SDK, which is necessary for interacting with Google Cloud services like the Container Registry. This command downloads and executes the installation script.

```bash
curl https://sdk.cloud.google.com | bash
```

--------------------------------

### ApiProperty Metadata Update Example (PHP)

Source: https://api-platform.com/docs/v2.7/core/upgrade-guide

Demonstrates the change in `ApiPlatformMetadataApiProperty` usage in API Platform 2.7 compared to older versions. It highlights the shift from `iri` to `types` and `type` to `builtinTypes`, explaining how PHP types are automatically inferred.

```php
<?php
// api/src/Entity/Book.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiProperty;

class Book
{
    #[ApiProperty(types: ['https://schema.org/Book'])]
    public string|Isbn $isbn;
}

```

--------------------------------

### GraphQL Query and Mutation Examples

Source: https://api-platform.com/docs/v2.7/distribution

Examples of GraphQL operations including a mutation to create a resource and queries to retrieve data, including nested relationships.

```GraphQL
mutation {
  createGreeting(input: {name: "Test2"}) {
    greeting {
      id
      name
    }
  }
}

{
  books {
    totalCount
    edges {
      node {
        id
        title
      }
    }
  }
}
```

--------------------------------

### Run Schema Generator (Standalone)

Source: https://api-platform.com/docs/v2.7/schema-generator/getting-started

Executes the Schema Generator with a specified configuration file. This command generates PHP classes in the 'api/src/' directory based on the provided schema configuration.

```bash
vendor/bin/schema generate api/src/ api/config/schema.yaml -vv

```

--------------------------------

### Install Alice Fixtures Bundle

Source: https://api-platform.com/docs/v2.7/distribution/testing

Installs the Alice fixture generator as a development dependency within the Docker container environment.

```bash
docker compose exec php \
    composer require --dev alice
```

--------------------------------

### Install Minimal API Platform Dependencies

Source: https://api-platform.com/docs/v2.7/core/bootstrap

A shell command to install the necessary Composer packages required to run a minimal version of the API Platform core library.

```bash
composer require \
    api-platform/core \
    doctrine/annotations \
    doctrine/common \
    phpdocumentor/reflection-docblock \
    symfony/property-info \
    symfony/routing
```

--------------------------------

### Build and Start Docker Services for API Platform

Source: https://api-platform.com/docs/v2.7/distribution

This command builds the necessary Docker images and then starts all the services defined in the Docker Compose file in detached mode. Make sure ports 80, 443, and 5432 are free on your host machine.

```bash
docker compose up -d

```

--------------------------------

### Start Development Server

Source: https://api-platform.com/docs/v2.7/create-client/nuxtjs

Launches the Nuxt.js development server to preview the generated application.

```bash
npm run dev
```

--------------------------------

### Initialize API Platform Admin in React App (JavaScript)

Source: https://api-platform.com/docs/v2.7/admin/getting-started

This code demonstrates how to integrate the HydraAdmin component into a React application's App.js file. It requires the @api-platform/admin library and specifies the API entrypoint.

```javascript
import { HydraAdmin } from "@api-platform/admin";

// Replace with your own API entrypoint
// For instance if https://example.com/api/books is the path to the collection of book resources, then the entrypoint is https://example.com/api
export default () => (
  <HydraAdmin entrypoint="https://demo.api-platform.com" />
);
```

--------------------------------

### Start Development Server

Source: https://api-platform.com/docs/v2.7/create-client/nextjs

Commands to launch the Next.js development server.

```bash
# using pnpm
pnpm dev
# or using npm
npm run dev
# or using yarn
yarn dev
```

--------------------------------

### Run Schema Generator (API Platform Distribution)

Source: https://api-platform.com/docs/v2.7/schema-generator/getting-started

Runs the Schema Generator within the API Platform Distribution environment using Docker Compose. This command generates PHP classes in the 'src/' directory based on the 'config/schema.yaml' configuration.

```bash
docker compose exec php \
    vendor/bin/schema generate src/ config/schema.yaml -vv

```

--------------------------------

### Install Bootstrap and Font Awesome (Optional)

Source: https://api-platform.com/docs/v2.7/create-client/vuejs

Installs Bootstrap for UI styling and Font Awesome for icon support. These are optional but recommended for a visually appealing application.

```bash
npm install add bootstrap font-awesome
```

--------------------------------

### GraphQL Mutation Example (GraphQL)

Source: https://api-platform.com/docs/v2.7/core/graphql

Demonstrates how to call custom GraphQL mutations defined in API Platform. This includes examples for a basic custom mutation, a mutation with custom arguments, and a mutation where specific stages are disabled.

```graphql
{
  mutation {
    mutationBook(input: {id: "/books/18", title: "The Fitz and the Fool"}) {
      book {
        title
      }
    }
  }

  mutation {
    withCustomArgsMutationBook(input: {sendMail: true, clientMutationId: "myId"}) {
      book {
        title
      }
      clientMutationId
    }
  }

  mutation {
    disabledStagesMutationBook(input: {id: "/books/18", title: "The Fitz and the Fool"}) {
      book {
        title
      }
      clientMutationId
    }
  }
}

```

--------------------------------

### Install Required Dependencies

Source: https://api-platform.com/docs/v2.7/create-client/nextjs

Installs necessary packages for the API Platform Next.js integration, including isomorphic-unfetch, formik, and react-query.

```bash
# using pnpm
pnpm install isomorphic-unfetch formik react-query
# or using npm
npm install isomorphic-unfetch formik react-query
# or using yarn
yarn add isomorphic-unfetch formik react-query
```

--------------------------------

### Install Testing Client Dependencies (Bash)

Source: https://api-platform.com/docs/v2.7/core/testing

Installs the necessary `symfony/browser-kit` and `symfony/http-client` packages using Composer within a Docker environment. These are required to enable the API Platform test client.

```bash
docker compose exec php \
    composer require symfony/browser-kit symfony/http-client

```

--------------------------------

### Install VichUploaderBundle with Composer

Source: https://api-platform.com/docs/v2.7/core/file-upload

Installs the VichUploaderBundle using Composer within a Dockerized PHP environment. This is the initial step to enable file upload capabilities.

```bash
docker compose exec php \
    composer require vich/uploader-bundle

```

--------------------------------

### Page-based Pagination Query Example (GraphQL)

Source: https://api-platform.com/docs/v2.7/core/graphql

Shows an example GraphQL query utilizing page-based pagination. It demonstrates how to request specific pages and items per page, and how to retrieve pagination details like 'itemsPerPage', 'lastPage', and 'totalCount'. This query is used after enabling page-based pagination for a resource.

```graphql
{
  offers(page: 3, itemsPerPage: 15) {
    collection {
      id
    }
    paginationInfo {
      itemsPerPage
      lastPage
      totalCount
    }
  }
}
```

--------------------------------

### API Platform v2.7 Serializer Component Setup

Source: https://api-platform.com/docs/v2.7/core/bootstrap

Configures the core Symfony Serializer component with necessary normalizers and encoders for API Platform. It includes setup for JSON encoding and handling various data types.

```php
$doctrineAnnotationReader = new AnnotationReader();
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader($doctrineAnnotationReader));

$serializer = new Serializer(
    [
        new UnwrappingDenormalizer(),
        new ProblemNormalizer(),
        new ConstraintViolationListNormalizer(),
        new DateTimeZoneNormalizer(),
        new DateIntervalNormalizer(),
        new DateTimeNormalizer(),
        new JsonSerializableNormalizer(),
        new DataUriNormalizer(),
        new ObjectNormalizer(
            null,
            null,
            null,
            new MetadataAwareNameConverter($classMetadataFactory)
        ),
        new ArrayDenormalizer(),
    ],
    [
        new JsonLdEncoder(),
        new JsonEncoder()
    ]
);
```

--------------------------------

### DataProvider Implementation (PHP)

Source: https://api-platform.com/docs/v2.7/core/bootstrap

Implements data provider interfaces for fetching collections and individual items of a resource. The example shows a basic implementation for a 'Book' resource, returning mock data. It supports collection retrieval, item retrieval by identifiers, and indicates support for any resource class and operation.

```php
class DataProvider implements DenormalizedIdentifiersAwareItemDataProviderInterface, RestrictedDataProviderInterface, ContextAwareCollectionDataProviderInterface

{
    public function getCollection(string $resourceClass, string $operationName = null, array $context = [])
    {
        $book = new Book();
        $book->id = '1';
        return [$book];
    }

    public function getItem(string $resourceClass, $identifiers, string $operationName = null, array $context = []) {
        $book = new Book();
        $book->id = $identifiers['id'];
        return $book;
    }

    public function supports(string $resourceClass, string $operationName = null, array $context = []): bool {
        return true;
    }
}

$dataProvider = new DataProvider();
```

--------------------------------

### Schema Generator Configuration (Enum Generation)

Source: https://api-platform.com/docs/v2.7/schema-generator/getting-started

A YAML configuration example for generating an enumeration class. The generator automatically detects subclasses of 'Enumeration' and creates a corresponding PHP Enum class.

```yaml
types:
    OfferItemCondition: # The generator will automatically guess that OfferItemCondition is subclass of Enum
        properties: {} # Remove all properties of the parent class

```

--------------------------------

### Declare API Resource with New Metadata Namespace (PHP)

Source: https://api-platform.com/docs/v2.7/core/upgrade-guide

Example demonstrating the updated `ApiPlatformMetadataApiResource` annotation in PHP for API Platform 2.7. It shows how to define resource types and operations using the new `operations` array with specific operation objects like `Get` and `Post`.

```php
<?php
// api/src/Entity/Book.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\Post;
use App\Controller\CreateBookPublication;

#[ApiResource(types: ['https://schema.org/Book'], operations: [
    new Get(),
    new Post(name: 'publication', uriTemplate: '/books/{id}/publication')
])]
class Book
{
    // ...
}
```

--------------------------------

### Implement Documentation Action Controller

Source: https://api-platform.com/docs/v2.7/core/bootstrap

A controller implementation that utilizes an OpenApiFactory to generate API documentation based on the current request context.

```php
final class DocumentationAction 
{
    private $openApiFactory;
    public function __construct(OpenApiFactoryInterface $openApiFactory)
    {
        $this->openApiFactory = $openApiFactory;
    }

    public function __invoke(Request $request): DocumentationInterface
    {
        $context = ['base_url' => $request->getBaseUrl(), 'spec_version' => 3];
        if ($request->query->getBoolean('api_gateway')) {
            // Implementation logic
        }
    }
}
```

--------------------------------

### Setting Sunset Header for a Specific Operation

Source: https://api-platform.com/docs/v2.7/core/deprecations

This example shows how to apply the `Sunset` HTTP header to a single, specific operation (e.g., a GET request) for a resource.

```APIDOC
## Setting the `Sunset` HTTP Header for a Specific Operation

### Description
This configuration sets the `Sunset` HTTP header specifically for the GET operation on the `Parchment` resource, indicating that this particular operation will be removed on '01/01/2020'.

### Method
GET

### Endpoint
N/A (Applies to a specific operation within a resource)

### Parameters
#### Operation Attribute
- **sunset** (string) - Required - The date string compatible with `\DateTime` constructor, indicating when the operation will be removed.
- **deprecationReason** (string) - Optional - A reason for the deprecation.

### Request Example
```php
<?php
// api/src/Entity/Parchment.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;

#[ApiResource]
#[Get(
    deprecationReason: 'Retrieve a Book instead',
    sunset: '01/01/2020'
)]
class Parchment
{
    // ...
}
```

### Response
#### Success Response (200)
- **Sunset** (string) - The date indicating when the operation will be removed.

#### Response Example
```http
Sunset: Wed, 01 Jan 2020 00:00:00 GMT
```
```

--------------------------------

### Schema Generator Configuration (OpenAPI)

Source: https://api-platform.com/docs/v2.7/schema-generator/getting-started

A YAML configuration file for the Schema Generator to use an OpenAPI documentation file. It specifies the path to the OpenAPI file, which can be in JSON or YAML format.

```yaml
# api/config/schema.yaml
openApi:
    file: '../openapi.yaml'

```

--------------------------------

### Register Normalizers and Initialize Serializer

Source: https://api-platform.com/docs/v2.7/core/bootstrap

Demonstrates how to register various normalizers into a list with specific priorities and initialize the main API Platform Serializer with encoders.

```php
$list->insert($problemConstraintViolationListNormalizer, -780);
$list->insert($objectNormalizer, -1000);
$encoders = [new JsonEncoder(), $jsonLdEncoder];
$serializer = new Serializer(iterator_to_array($list), $encoders);
```

--------------------------------

### Schema Generator Configuration (Model Scaffolding)

Source: https://api-platform.com/docs/v2.7/schema-generator/getting-started

A sample YAML configuration file for the Schema Generator to scaffold data models. It defines types like 'Thing', 'Person', and 'PostalAddress', specifying their properties and inheritance.

```yaml
# api/config/schema.yaml
# The list of types and properties we want to use
types:
    # Parent class of Person
    Thing:
        properties:
            name: ~
    Person:
        # Enable the generation of the class hierarchy (not enabled by default)
        parent: ~
        properties:
            familyName: ~
            givenName: ~
            additionalName: ~
            address: ~
    PostalAddress:
        properties:
            # Force the type of the addressCountry property to text
            addressCountry: { range: "Text" }
            addressLocality: ~
            addressRegion: ~
            postOfficeBoxNumber: ~
            postalCode: ~
            streetAddress: ~

```

--------------------------------

### Load Data Fixtures

Source: https://api-platform.com/docs/v2.7/distribution/testing

Executes the console command to populate the database with the defined fixture datasets.

```bash
docker compose exec php \
    bin/console hautelook:fixtures:load
```

--------------------------------

### Clear Cache for Symfony/API Platform (Bash)

Source: https://api-platform.com/docs/v2.7/admin/getting-started

This command clears the application cache for a Symfony project using Docker Compose. It's necessary after making changes to configuration files, such as CORS settings, to ensure they are applied.

```bash
docker compose exec php \
    bin/console cache:clear --env=prod
```

--------------------------------

### Deprecate Operation in PHP

Source: https://api-platform.com/docs/v2.7/core/deprecations

Deprecates a specific operation (e.g., a GET request) on a resource using the `deprecationReason` attribute. This allows for finer-grained control over deprecation within a resource, guiding clients to use alternative operations.

```php
<?php
// api/src/Entity/Parchment.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;

#[ApiResource]
#[Get(deprecationReason: 'Retrieve a Book instead')]
class Parchment
{
    // ...
}

```

--------------------------------

### Configure API Platform Routes and Kernel

Source: https://api-platform.com/docs/v2.7/core/bootstrap

This code initializes the OpenApiFactory and various action controllers to handle API documentation, entry points, and JSON-LD contexts. It then sets up the Symfony HttpKernel to process global requests and manage the application lifecycle.

```php
$paginationOptions = new PaginationOptions();
$openApiOptions = new OpenApiOptions('API Platform');
$jsonSchemaTypeFactory = new TypeFactory($resourceClassResolver);
$jsonSchemaFactory = new SchemaFactory($jsonSchemaTypeFactory, $resourceMetadataFactory, $propertyNameCollectionFactory, $propertyMetadataFactory, $nameConverter, $resourceClassResolver);

$openApiFactory = new OpenApiFactory($resourceNameCollectionFactory, $resourceMetadataFactory, $propertyNameCollectionFactory, $propertyMetadataFactory, $jsonSchemaFactory, $jsonSchemaTypeFactory, $operationPathResolver, $filterLocator, $subresourceOperationFactory, $identifiersExtractor, $formats, $openApiOptions, $paginationOptions);
$documentationAction = new DocumentationAction($openApiFactory);
$routes->add('api_doc', new Route('/docs.{_format}', ['_controller' => $documentationAction, '_format' => null, '_api_respond' => true]));

$entryPointAction = new EntrypointAction($resourceNameCollectionFactory);
$routes->add('api_entrypoint', new Route('/{index}.{_format}', ['_controller' => $entryPointAction, '_format' => null, '_api_respond' => true, 'index' => 'index'], ['index' => 'index']));

$contextAction = new ContextAction($jsonLdContextBuilder, $resourceNameCollectionFactory, $resourceMetadataFactory);
$routes->add('api_jsonld_context', new Route('/contexts/{shortName}.{_format}', ['_controller' => $contextAction, '_format' => 'jsonld', '_api_respond' => true], ['shortName' => '.+']));

$controllerResolver = new ControllerResolver();
$argumentResolver = new ArgumentResolver();

$kernel = new HttpKernel($dispatcher, $controllerResolver, new RequestStack(), $argumentResolver);

$request = Request::createFromGlobals();
$response = $kernel->handle($request);
$response->send();
$kernel->terminate($request, $response);
```

--------------------------------

### Default API Resource Declaration (PHP)

Source: https://api-platform.com/docs/v2.7/core/upgrade-guide

Illustrates the default `#[ApiResource]` attribute in API Platform 2.7, which implicitly defines standard CRUD operations. This is equivalent to explicitly listing `Get`, `Put`, `Patch`, `Delete`, `GetCollection`, and `Post` operations.

```php
#[ApiResource]


```

--------------------------------

### Configure CORS for API Platform (YAML)

Source: https://api-platform.com/docs/v2.7/admin/getting-started

This YAML configuration snippet is for NelmioCorsBundle in a Symfony project. It sets up CORS headers for the '/api/' path, allowing specific origins, methods, headers, and exposing the 'Link' header. This is crucial for the admin interface to access the API.

```yaml
# config/packages/nelmio_cors.yaml

nelmio_cors:
    paths:
        '^/api/':
            origin_regex: true
            allow_origin: ['^http://localhost:[0-9]+'] # You probably want to change this regex to match your real domain
            allow_methods: ['GET', 'OPTIONS', 'POST', 'PUT', 'PATCH', 'DELETE']
            allow_headers: ['Content-Type', 'Authorization']
            expose_headers: ['Link']
            max_age: 3600
```

--------------------------------

### Start Production Services with Docker Compose

Source: https://api-platform.com/docs/v2.7/deployment/docker-compose

Deploys the application in production mode by setting necessary environment variables and running the production-specific Docker Compose configuration.

```bash
SERVER_NAME=your-domain-name.example.com \
APP_SECRET=ChangeMe \
POSTGRES_PASSWORD=ChangeMe \
CADDY_MERCURE_JWT_SECRET=ChangeMe \
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
```

--------------------------------

### Explicit CRUD Operations for API Resource (PHP)

Source: https://api-platform.com/docs/v2.7/core/upgrade-guide

Shows the explicit declaration of all default CRUD operations for an `ApiResource` in API Platform 2.7. This includes `Get`, `Put`, `Patch`, `Delete` for single items, and `GetCollection`, `Post` for collections, using the `operations` array.

```php
#[ApiResource(operations: [
    new Get(),
    new Put(),
    new Patch(),
    new Delete(),
    new GetCollection(),
    new Post(),
])]

```

--------------------------------

### Declare API Resource with Old Metadata Namespace (PHP)

Source: https://api-platform.com/docs/v2.7/core/upgrade-guide

Example showing the `ApiPlatformCoreAnnotationApiResource` annotation used in API Platform 2.6. This illustrates the older way of defining resources, including IRI, item operations, and specific operation configurations like `post_publication`.

```php
<?php
// api/src/Entity/Book.php
namespace App\Entity;

use ApiPlatform\Core\Annotation\ApiResource;

#[ApiResource(
    iri: 'https://schema.org/Book',
    itemOperations: [
        'get',
        'post_publication' => [
            'method' => 'POST',
            'path' => '/books/{id}/publication',
        ]
    ])
]
class Book
{
    // ...
}
```

--------------------------------

### Execute GraphQL Queries

Source: https://api-platform.com/docs/v2.7/core/graphql

Example GraphQL queries demonstrating how to call custom operations defined in the API Platform resource configuration.

```graphql
{
  retrievedQueryBook(id: "/books/56") { title }
  notRetrievedQueryBook { title }
  withDefaultArgsNotRetrievedQueryBook(id: "/books/56") { title }
  withCustomArgsQueryBook(id: "/books/23", log: true, logDate: "2019-12-20") { title }
  collectionQueryBooks { edges { node { title } } }
}
```

--------------------------------

### Define API Platform Resources in YAML and XML

Source: https://api-platform.com/docs/v2.7/core/getting-started

Demonstrates how to map entities to API resources using YAML and XML formats. These configurations allow for setting metadata like descriptions, types, and pagination settings for specific entities.

```yaml
resources:
    App\Entity\Product: ~
    App\Entity\Offer:
        shortName: 'Offer'
        description: 'An offer from my shop'
        types: ['https://schema.org/Offer']
        paginationItemsPerPage: 25
```

```xml
<resource class="App\Entity\Product" />
<resource
    class="App\Entity\Offer"
    shortName="Offer"
    description="An offer from my shop"
>
    <types>
        <type>https://schema.org/Offer</type>
    </types>
</resource>
```

--------------------------------

### Configure Providers and Processors with Doctrine

Source: https://api-platform.com/docs/v2.7/core/upgrade-guide

This PHP code snippet demonstrates how to configure Providers and Processors for different HTTP operations (GET, GETCollection, POST, PUT, DELETE) using Doctrine's state management classes. It specifies the processor and provider for each operation directly within the `#[ApiResource]` metadata.

```php
<?php

use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Delete;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;

#[Put(processor: ApiPlatform\Doctrine\Common\State\PersistProcessor::class, provider: ApiPlatform\Doctrine\Orm\State\ItemProvider::class)]
#[Post(processor: ApiPlatform\Doctrine\Common\State\PersistProcessor::class)]
#[Delete(processor: ApiPlatform\Doctrine\Common\State\RemoveProcessor::class)]
#[Get(provider: ApiPlatform\Doctrine\Orm\State\ItemProvider::class)]
#[GetCollection(provider: ApiPlatform\Doctrine\Orm\State\CollectionProvider::class)]
class Book {}

```

--------------------------------

### API Platform v2.7 Property Info Extractor Setup

Source: https://api-platform.com/docs/v2.7/core/bootstrap

Initializes the PropertyInfoExtractor using ReflectionExtractor and PhpDocExtractor for extracting property information. This is crucial for serialization and documentation generation.

```php
$phpDocExtractor = new PhpDocExtractor();
$reflectionExtractor = new ReflectionExtractor();

$propertyInfo = new PropertyInfoExtractor(
    [$reflectionExtractor],
    [$phpDocExtractor, $reflectionExtractor],
    [$phpDocExtractor],
    [$reflectionExtractor],
    [$reflectionExtractor]
);
```

--------------------------------

### Install Vuex and Map Fields Dependencies

Source: https://api-platform.com/docs/v2.7/create-client/vuejs

Installs Vuex for state management and vuex-map-fields for easier state mapping in Vue.js components. Lodash is also installed for utility functions.

```bash
npm install vuex@3 vuex-map-fields lodash
```

--------------------------------

### Enable GraphQL Support via Composer

Source: https://api-platform.com/docs/v2.7/distribution

Provides the shell commands required to install the webonyx/graphql-php library and clear the cache within the API Platform Docker environment.

```Bash
docker compose exec php sh -c '
    composer require webonyx/graphql-php
    bin/console cache:clear
'
```

--------------------------------

### Symfony Messenger Installation

Source: https://api-platform.com/docs/v2.7/core/messenger

Instructions on how to install the Symfony Messenger component to enable its integration with API Platform.

```APIDOC
## Installing Symfony Messenger

### Description
To enable the support of Messenger, install the library using Composer.

### Method
Shell Command

### Endpoint
N/A

### Parameters
None

### Request Example
```bash
docker compose exec php \
    composer require messenger
```

### Response
N/A
```

--------------------------------

### Initialize Nuxt.js Application

Source: https://api-platform.com/docs/v2.7/create-client/nuxtjs

Commands to scaffold a new Nuxt.js project. It includes the initialization command and the recommended configuration answers for compatibility with the API Platform generator.

```bash
npm init nuxt-app your-app-name
```

```text
Project name: your-app-name
Programming language: JavaScript
Package manager: NPM
UI framework: Vuetify.js
Nuxt.js modules: None
Linting tools: Prettier, Lint staged files
Testing framework: None
Rendering mode: Single Page App
Deployment target: Static (Static/JAMStack hosting)
```

--------------------------------

### Upgrade API Platform with Helm

Source: https://api-platform.com/docs/v2.7/deployment/kubernetes

Example of upgrading a Helm release using the :latest tag strategy. It demonstrates setting image repositories, tags, and pull policies to ensure the latest code is deployed.

```bash
PHP_POD=$(kubectl --namespace=bar get pods -l app=php -o jsonpath="{.items[0].metadata.name}")
kubectl --namespace=bar exec -it $PHP_POD -- bin/console doctrine:schema:create
helm upgrade api-platform ./helm/api-platform --namespace=default \
    --set "php.image.repository=gcr.io/test-api-platform/php" \
    --set php.image.tag=latest \
    --set "caddy.image.repository=gcr.io/test-api-platform/caddy" \
    --set caddy.image.tag=latest \
    --set "pwa.image.repository=gcr.io/test-api-platform/pwa" \
    --set pwa.image.tag=latest \
    --set php.appSecret='!ChangeMe!' \
    --set postgresql.postgresqlPassword='!ChangeMe!' \
    --set postgresql.persistence.enabled=true \
    --set "corsAllowOrigin=^https?://[a-z]*\.mywebsite.com$" \
    --set php.image.pullPolicy=Always \
    --set caddy.image.pullPolicy=Always \
    --set pwa.image.pullPolicy=Always
```

--------------------------------

### Inspect Xdebug Installation

Source: https://api-platform.com/docs/v2.7/distribution/debugging

This command allows you to verify the Xdebug installation within your Docker container. Executing `php --version` inside the `php` service container will display the installed PHP version along with the Xdebug version, confirming its successful integration.

```bash
$ docker compose exec php \
    php --version

PHP …
    with Xdebug v3.1.3, Copyright (c) 2002-2021, by Derick Rethans
    …


```

--------------------------------

### Create Book Resource via JSON

Source: https://api-platform.com/docs/v2.7/distribution

Example JSON payload for creating a new book resource. This demonstrates the structure expected by the API Platform for entity persistence.

```json
{
  "description": "This book is designed for PHP developers and architects who want to modernize their skills through better understanding of Persistence and ORM.",
  "author": "Kévin Dunglas",
  "publicationDate": "2013-12-01"
}
```

--------------------------------

### Cursor-based Pagination Example (GraphQL)

Source: https://api-platform.com/docs/v2.7/core/graphql

Demonstrates how to use cursor-based pagination in GraphQL queries. It shows how to fetch data using 'first' and 'after' parameters, and how to retrieve pagination information like 'endCursor' and 'hasNextPage'. This method is suitable for large datasets where efficient forward-only navigation is required.

```graphql
{
  offers(first: 10, after: "cursor") {
    totalCount
    pageInfo {
      endCursor
      hasNextPage
    }
    edges {
      cursor
      node {
        id
      }
    }
  }
}
```

```graphql
{
  offers(first: 10, after: "endCursor") {
  }
}
```

```graphql
{
  offers(last: 10, before: "startCursor") {
  }
}
```

--------------------------------

### Install Generator Dependencies

Source: https://api-platform.com/docs/v2.7/create-client/nuxtjs

Installs the required runtime and development dependencies for the Nuxt.js generator, including Vuetify and FontAwesome integration.

```bash
npm install moment lodash vue-i18n vuelidate vuex-map-fields nuxt-i18n
npm install --dev @nuxtjs/vuetify @nuxtjs/fontawesome
```

--------------------------------

### Initialize API Platform Services and Normalizers

Source: https://api-platform.com/docs/v2.7/core/bootstrap

Instantiates core API Platform services such as IriConverter, WriteListener, and various normalizers for JSON-LD, Hydra, and HAL formats. These components are essential for transforming resource data into specific API formats.

```php
$iriConverter = new IriConverter($propertyNameCollectionFactory, $propertyMetadataFactory, $dataProvider, $routeNameResolver, $router, $propertyAccessor, $identifiersExtractor, null, $identifierConverter, $resourceClassResolver, $resourceMetadataFactory);
$writeListener = new WriteListener($dataPersister, $iriConverter, $resourceMetadataFactory, $resourceClassResolver);
$jsonLdEncoder = new JsonLdEncoder('jsonld', new JsonEncoder());
```

--------------------------------

### Install LexikJWTAuthenticationBundle

Source: https://api-platform.com/docs/v2.7/core/jwt

Installs the LexikJWTAuthenticationBundle using Composer. This is the first step to enable JWT authentication in your API Platform project.

```bash
docker compose exec php \
    composer require jwt-auth

```

--------------------------------

### Bootstrap Minimal API Platform Instance

Source: https://api-platform.com/docs/v2.7/core/bootstrap

A PHP script demonstrating the manual import of core API Platform classes. This serves as the foundation for a custom, lightweight implementation of the framework.

```php
<?php

require './vendor/autoload.php';

use ApiPlatform\Core\Action\EntrypointAction;
use ApiPlatform\Core\Action\ExceptionAction;
use ApiPlatform\Core\Action\PlaceholderAction;
use ApiPlatform\Core\Api\IdentifiersExtractor;
use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Api\ResourceClassResolver;
use ApiPlatform\Core\Api\UrlGeneratorInterface as ApiUrlGeneratorInterface;
use ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameGenerator;
use ApiPlatform\Core\Bridge\Symfony\Validator\EventListener\ValidationExceptionListener;
use ApiPlatform\Core\Documentation\DocumentationInterface;
use ApiPlatform\Core\EventListener\AddFormatListener;
use ApiPlatform\Core\EventListener\DeserializeListener;
use ApiPlatform\Core\EventListener\ExceptionListener;
use ApiPlatform\Core\EventListener\ReadListener;
use ApiPlatform\Core\EventListener\WriteListener;
// ... (additional imports omitted for brevity)
```

--------------------------------

### Install Elasticsearch PHP Client

Source: https://api-platform.com/docs/v2.7/core/elasticsearch

Installs the official PHP client for Elasticsearch using Composer. This is a prerequisite for enabling Elasticsearch support in API Platform.

```bash
composer require elasticsearch/elasticsearch:^6.0

```

--------------------------------

### Configure Vue.js Main Application Entry Point

Source: https://api-platform.com/docs/v2.7/create-client/vuejs

Sets up the main Vue.js application file (main.js) by importing necessary libraries (Vue, Vuex, VueRouter), UI assets (Bootstrap, Font Awesome), generated store modules, and routes. It initializes Vuex store and VueRouter, then mounts the root App component.

```javascript
// main.js
import Vue from 'vue'
import Vuex from 'vuex';
import VueRouter from 'vue-router';
import App from './App.vue';
import 'bootstrap/dist/css/bootstrap.css';
import 'font-awesome/css/font-awesome.css';
import book from './store/modules/book/';
import bookRoutes from './router/book';

Vue.config.productionTip = false;

Vue.use(Vuex);
Vue.use(VueRouter);

const store = new Vuex.Store({
  modules: {
    book,
  }
});

const router = new VueRouter({
  mode: 'history',
  routes: [
      ...bookRoutes,
  ],
});

new Vue({
  store,
  router,
  render: h => h(App),
}).$mount('#app');
```

--------------------------------

### Subresource Example: Retrieving Related Questions for an Answer

Source: https://api-platform.com/docs/v2.7/core/subresources

This example shows how to configure a subresource to retrieve a collection of 'relatedQuestions' associated with a specific 'Answer' entity.

```APIDOC
## GET /answers/{id}/related_questions.{_format}

### Description
Retrieves a collection of 'relatedQuestions' associated with a specific 'Answer' identified by its ID.

### Method
GET

### Endpoint
`/answers/{id}/related_questions.{_format}`

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the 'Answer' resource.
- **_format** (string) - Optional - The desired response format (e.g., json, xml).

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- An array of 'Question' objects representing the related questions.

#### Response Example
```json
[
  {
    "id": 101,
    "content": "What is the meaning of life?"
  },
  {
    "id": 102,
    "content": "Is there intelligent life elsewhere in the universe?"
  }
]
```
```

--------------------------------

### API Platform v2.7 Route Loading (PHP)

Source: https://api-platform.com/docs/v2.7/core/bootstrap

Demonstrates the process of loading API routes within API Platform v2.7. It iterates through discovered resource classes, retrieves their metadata, and adds routes for collection and item operations based on the configuration. Includes error handling for resources without a short name.

```php
$propertyAccessor = PropertyAccess::createPropertyAccessor();
$identifiersExtractor = new IdentifiersExtractor($propertyNameCollectionFactory, $propertyMetadataFactory, $propertyAccessor);
$pathSegmentNameGenerator = new UnderscorePathSegmentNameGenerator(); 
$operationPathResolver = new OperationPathResolver($pathSegmentNameGenerator);
$subresourceOperationFactory = new SubresourceOperationFactory($resourceMetadataFactory, $propertyNameCollectionFactory, $propertyMetadataFactory, $pathSegmentNameGenerator);

class ApiLoader {
    private $resourceNameCollectionFactory;
    private $resourceMetadataFactory;
    private $identifiersExtractor;
    private $operationPathResolver;

    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, IdentifiersExtractorInterface $identifiersExtractor, OperationPathResolverInterface $operationPathResolver)
    {
        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->identifiersExtractor = $identifiersExtractor;
        $this->operationPathResolver = $operationPathResolver;
    }

    public function load(): RouteCollection
    {
        $routeCollection = new RouteCollection();

        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
            $resourceShortName = $resourceMetadata->getShortName();

            if (null === $resourceShortName) {
                throw new InvalidResourceException(sprintf('Resource %s has no short name defined.', $resourceClass));
            }

            if (null !== $collectionOperations = $resourceMetadata->getCollectionOperations()) {
                foreach ($collectionOperations as $operationName => $operation) {
                    $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::COLLECTION);
                }
            }

            if (null !== $itemOperations = $resourceMetadata->getItemOperations()) {
                foreach ($itemOperations as $operationName => $operation) {

```

--------------------------------

### Start React Native Application

Source: https://api-platform.com/docs/v2.7/create-client/react-native

Starts the React Native development server using Expo CLI, allowing you to run the application on simulators or devices.

```bash
expo start
```