Reference

ApiPlatform\OpenApi\Factory\OpenApiFactory Class

Generates an Open API v3 specification.

class ApiPlatform\OpenApi\Factory\OpenApiFactory implements <a href="/docs/reference/OpenApi/Factory/OpenApiFactoryInterface">ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface</a>
{
    public __construct(<a href="/docs/reference/Metadata/Resource/Factory/ResourceNameCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface</a> $resourceNameCollectionFactory, <a href="/docs/reference/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a> $resourceMetadataFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a> $propertyNameCollectionFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a> $propertyMetadataFactory, <a href="/docs/reference/JsonSchema/SchemaFactoryInterface">ApiPlatform\JsonSchema\SchemaFactoryInterface</a> $jsonSchemaFactory, <a href="/docs/reference/JsonSchema/TypeFactoryInterface">ApiPlatform\JsonSchema\TypeFactoryInterface</a> $jsonSchemaTypeFactory, Psr\Container\ContainerInterface $filterLocator, array $formats, null|<a href="/docs/reference/OpenApi/Options">ApiPlatform\OpenApi\Options</a> $openApiOptions, null|<a href="/docs/reference/State/Pagination/PaginationOptions">ApiPlatform\State\Pagination\PaginationOptions</a> $paginationOptions, null|Symfony\Component\Routing\RouterInterface $router)
    public __invoke(array $context): <a href="/docs/reference/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>
}
class ApiPlatform\OpenApi\Factory\OpenApiFactory implements <a href="/docs/reference/OpenApi/Factory/OpenApiFactoryInterface">ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface</a>
{
    public __construct(<a href="/docs/reference/Metadata/Resource/Factory/ResourceNameCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface</a> $resourceNameCollectionFactory, <a href="/docs/reference/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a> $resourceMetadataFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a> $propertyNameCollectionFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a> $propertyMetadataFactory, <a href="/docs/reference/JsonSchema/SchemaFactoryInterface">ApiPlatform\JsonSchema\SchemaFactoryInterface</a> $jsonSchemaFactory, <a href="/docs/reference/JsonSchema/TypeFactoryInterface">ApiPlatform\JsonSchema\TypeFactoryInterface</a> $jsonSchemaTypeFactory, Psr\Container\ContainerInterface $filterLocator, array $formats, null|<a href="/docs/reference/OpenApi/Options">ApiPlatform\OpenApi\Options</a> $openApiOptions, null|<a href="/docs/reference/State/Pagination/PaginationOptions">ApiPlatform\State\Pagination\PaginationOptions</a> $paginationOptions, null|Symfony\Component\Routing\RouterInterface $router)
    public __invoke(array $context): <a href="/docs/reference/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>
}

See

parse @see phpdoc

Methods

__construct

public __construct(<a href="/docs/reference/Metadata/Resource/Factory/ResourceNameCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface</a> $resourceNameCollectionFactory, <a href="/docs/reference/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a> $resourceMetadataFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a> $propertyNameCollectionFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a> $propertyMetadataFactory, <a href="/docs/reference/JsonSchema/SchemaFactoryInterface">ApiPlatform\JsonSchema\SchemaFactoryInterface</a> $jsonSchemaFactory, <a href="/docs/reference/JsonSchema/TypeFactoryInterface">ApiPlatform\JsonSchema\TypeFactoryInterface</a> $jsonSchemaTypeFactory, Psr\Container\ContainerInterface $filterLocator, array $formats, null|<a href="/docs/reference/OpenApi/Options">ApiPlatform\OpenApi\Options</a> $openApiOptions, null|<a href="/docs/reference/State/Pagination/PaginationOptions">ApiPlatform\State\Pagination\PaginationOptions</a> $paginationOptions, null|Symfony\Component\Routing\RouterInterface $router)
public __construct(<a href="/docs/reference/Metadata/Resource/Factory/ResourceNameCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface</a> $resourceNameCollectionFactory, <a href="/docs/reference/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a> $resourceMetadataFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a> $propertyNameCollectionFactory, <a href="/docs/reference/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a> $propertyMetadataFactory, <a href="/docs/reference/JsonSchema/SchemaFactoryInterface">ApiPlatform\JsonSchema\SchemaFactoryInterface</a> $jsonSchemaFactory, <a href="/docs/reference/JsonSchema/TypeFactoryInterface">ApiPlatform\JsonSchema\TypeFactoryInterface</a> $jsonSchemaTypeFactory, Psr\Container\ContainerInterface $filterLocator, array $formats, null|<a href="/docs/reference/OpenApi/Options">ApiPlatform\OpenApi\Options</a> $openApiOptions, null|<a href="/docs/reference/State/Pagination/PaginationOptions">ApiPlatform\State\Pagination\PaginationOptions</a> $paginationOptions, null|Symfony\Component\Routing\RouterInterface $router)

Parameters

resourceNameCollectionFactoryApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface
resourceMetadataFactoryApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface
propertyNameCollectionFactoryApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface
propertyMetadataFactoryApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface
jsonSchemaFactoryApiPlatform\JsonSchema\SchemaFactoryInterface
jsonSchemaTypeFactoryApiPlatform\JsonSchema\TypeFactoryInterface
filterLocatorPsr\Container\ContainerInterface
formatsarray
openApiOptionsApiPlatform\OpenApi\Options
paginationOptionsApiPlatform\State\Pagination\PaginationOptions
routerSymfony\Component\Routing\RouterInterface

__invoke

Creates an OpenApi class.

public __invoke(array $context): <a href="/docs/reference/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>
public __invoke(array $context): <a href="/docs/reference/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

Creates an OpenApi class.

Parameters

contextarray

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop