Api Platform conference
Register now
References Documentation
API Platform Conference
September 19-20, 2024 | Lille & online

The international conference on the API Platform Framework

API Platform Conference 2024: meet the best PHP, JavaScript and API experts

Learn more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.

Register now
Reference
C
Class

ApiPlatform\Documentation\Documentation

Generates the API documentation.

class ApiPlatform\Documentation\Documentation implements ApiPlatform\Documentation\DocumentationInterface
{
    public __construct(ApiPlatform\Metadata\Resource\ResourceNameCollection $resourceNameCollection, string $title, string $description, string $version)
    public getVersion(): string
    public getDescription(): string
    public getTitle(): string
    public getResourceNameCollection(): ApiPlatform\Metadata\Resource\ResourceNameCollection
}

Methods

__construct

public __construct(ApiPlatform\Metadata\Resource\ResourceNameCollection $resourceNameCollection, string $title, string $description, string $version)

Parameters

resourceNameCollection`ApiPlatform\Metadata\Resource\ResourceNameCollection`
titlestring
descriptionstring
versionstring

getVersion

public getVersion(): string

Returns

string

getDescription

public getDescription(): string

Returns

string

getTitle

public getTitle(): string

Returns

string

getResourceNameCollection

public getResourceNameCollection(): ApiPlatform\Metadata\Resource\ResourceNameCollection

Returns

<a href="/docs/references/Metadata/Resource/ResourceNameCollection">ApiPlatform\Metadata\Resource\ResourceNameCollection</a>

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop