References
DocumentationAction
September 19-20, 2024 | Lille & online
The international conference on the API Platform Framework
Get ready for game-changing announcements for the PHP community!
The API Platform Conference 2024 is happening soon, and it's close to selling out.
API Platform 4, Caddy web server, Xdebug, AI... Enjoy two days of inspiring talks with our friendly community and our amazing speakers.
Reference
C
Class# ApiPlatform\Symfony\Action\DocumentationAction
Generates the API documentation.
class ApiPlatform\Symfony\Action\DocumentationAction
{
public __construct($resourceNameCollectionFactory, string $title, string $description, string $version, null|`<a href="/docs/references/OpenApi/Factory/OpenApiFactoryInterface">ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface</a>` $openApiFactory, null|`<a href="/docs/references/State/ProviderInterface">ApiPlatform\State\ProviderInterface</a>` $provider, null|`<a href="/docs/references/State/ProcessorInterface">ApiPlatform\State\ProcessorInterface $processor, null|Negotiation\Negotiator $negotiator, array $documentationFormats)
public __invoke(null|Symfony\Component\HttpFoundation\Request $request): |`<a href="/docs/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi|Symfony\Component\HttpFoundation\Response
}# Methods
# __construct
public __construct($resourceNameCollectionFactory, string $title, string $description, string $version, null|`<a href="/docs/references/OpenApi/Factory/OpenApiFactoryInterface">ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface</a>` $openApiFactory, null|`<a href="/docs/references/State/ProviderInterface">ApiPlatform\State\ProviderInterface</a>` $provider, null|`<a href="/docs/references/State/ProcessorInterface">ApiPlatform\State\ProcessorInterface $processor, null|Negotiation\Negotiator $negotiator, array $documentationFormats)# Parameters
| resourceNameCollectionFactory | `ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface` | |
| title | string | |
| description | string | |
| version | string | |
| openApiFactory | `ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface` | |
| provider | `ApiPlatform\State\ProviderInterface` | |
| processor | `ApiPlatform\State\ProcessorInterface` | |
| negotiator | Negotiation\Negotiator | |
| documentationFormats | array |
# __invoke
public __invoke(null|Symfony\Component\HttpFoundation\Request $request): |`<a href="/docs/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi|Symfony\Component\HttpFoundation\Response# Parameters
| request | Symfony\Component\HttpFoundation\Request |
