ApiPlatform\Documentation\Action\DocumentationAction

Generates the API documentation.

class ApiPlatform\Documentation\Action\DocumentationAction
{
    public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, string $title, string $description, string $version, null|ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface $openApiFactory)
    public __invoke(null|Symfony\Component\HttpFoundation\Request $request): ApiPlatform\Documentation\DocumentationInterface|ApiPlatform\OpenApi\OpenApi
}

class ApiPlatform\Documentation\Action\DocumentationAction
{
    public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, string $title, string $description, string $version, null|ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface $openApiFactory)
    public __invoke(null|Symfony\Component\HttpFoundation\Request $request): ApiPlatform\Documentation\DocumentationInterface|ApiPlatform\OpenApi\OpenApi
}

Methods

__construct

public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, string $title, string $description, string $version, null|ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface $openApiFactory)

public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, string $title, string $description, string $version, null|ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface $openApiFactory)

Parameters

resourceNameCollectionFactory	ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface
title	string
description	string
version	string
openApiFactory	ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface

__invoke

public __invoke(null|Symfony\Component\HttpFoundation\Request $request): ApiPlatform\Documentation\DocumentationInterface|ApiPlatform\OpenApi\OpenApi

public __invoke(null|Symfony\Component\HttpFoundation\Request $request): ApiPlatform\Documentation\DocumentationInterface|ApiPlatform\OpenApi\OpenApi

Parameters

request

Symfony\Component\HttpFoundation\Request