References OpenApi
Reference
C
Class

ApiPlatform\OpenApi\OpenApi

class ApiPlatform\OpenApi\OpenApi
{
    public __construct($info, array $servers, `<a href="/docs/main/references/OpenApi/Model/Paths">ApiPlatform\OpenApi\Model\Paths</a>` $paths, null|`<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components $components, array $security, array $tags, $externalDocs, null|string $jsonSchemaDialect, null|ArrayObject $webhooks)
    public getOpenapi(): string
    public getInfo(): ApiPlatform\OpenApi\Model\Info
    public getServers(): array
    public getPaths(): ApiPlatform\OpenApi\Model\Paths
    public getComponents(): ApiPlatform\OpenApi\Model\Components
    public getSecurity(): array
    public getTags(): array
    public getExternalDocs(): array
    public getJsonSchemaDialect(): string
    public getWebhooks(): ArrayObject
    public withOpenapi(string $openapi): ApiPlatform\OpenApi\OpenApi
    public withInfo($info): `<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi
    public withServers(array $servers): ApiPlatform\OpenApi\OpenApi
    public withPaths($paths): `<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi
    public withComponents($components): `<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi
    public withSecurity(array $security): ApiPlatform\OpenApi\OpenApi
    public withTags(array $tags): ApiPlatform\OpenApi\OpenApi
    public withExternalDocs(array $externalDocs): ApiPlatform\OpenApi\OpenApi
    public withJsonSchemaDialect(null|string $jsonSchemaDialect): ApiPlatform\OpenApi\OpenApi
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

Parameters

info`ApiPlatform\OpenApi\Model\Info`
serversarray
paths`ApiPlatform\OpenApi\Model\Paths`
components`ApiPlatform\OpenApi\Model\Components`
securityarray
tagsarray
externalDocs
jsonSchemaDialectstring
webhooksArrayObject

getOpenapi

public getOpenapi(): string

Returns

string

getInfo

Returns

<a href="/docs/main/references/OpenApi/Model/Info">ApiPlatform\OpenApi\Model\Info</a>

getServers

public getServers(): array

Returns

array

getPaths

Returns

<a href="/docs/main/references/OpenApi/Model/Paths">ApiPlatform\OpenApi\Model\Paths</a>

getComponents

public getComponents(): ApiPlatform\OpenApi\Model\Components

Returns

<a href="/docs/main/references/OpenApi/Model/Components">ApiPlatform\OpenApi\Model\Components</a>

getSecurity

public getSecurity(): array

Returns

array

getTags

public getTags(): array

Returns

array

getExternalDocs

public getExternalDocs(): array

Returns

array

getJsonSchemaDialect

public getJsonSchemaDialect(): string

Returns

string

getWebhooks

public getWebhooks(): ArrayObject

Returns

ArrayObject

withOpenapi

public withOpenapi(string $openapi): ApiPlatform\OpenApi\OpenApi

Parameters

openapistring

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withInfo

Parameters

info`ApiPlatform\OpenApi\Model\Info`

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withServers

public withServers(array $servers): ApiPlatform\OpenApi\OpenApi

Parameters

serversarray

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withPaths

Parameters

paths`ApiPlatform\OpenApi\Model\Paths`

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withComponents

Parameters

components`ApiPlatform\OpenApi\Model\Components`

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withSecurity

public withSecurity(array $security): ApiPlatform\OpenApi\OpenApi

Parameters

securityarray

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withTags

public withTags(array $tags): ApiPlatform\OpenApi\OpenApi

Parameters

tagsarray

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withExternalDocs

public withExternalDocs(array $externalDocs): ApiPlatform\OpenApi\OpenApi

Parameters

externalDocsarray

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withJsonSchemaDialect

public withJsonSchemaDialect(null|string $jsonSchemaDialect): ApiPlatform\OpenApi\OpenApi

Parameters

jsonSchemaDialectstring

Returns

<a href="/docs/main/references/OpenApi/OpenApi">ApiPlatform\OpenApi\OpenApi</a>

withExtensionProperty

public withExtensionProperty(string $key, $value)

Parameters

keystring
value

Returns

getExtensionProperties

public getExtensionProperties(): array

Returns

array

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