Documentation

OpenAPIDefinition
in package
implements OpenApiAttributeInterface

The attribute that may be used to populate OpenAPI Object fields info, tags, servers, security and externalDocs.

If more than one class is annotated with OpenAPIDefinition, with the same fields defined, behaviour is inconsistent.

Interfaces, Classes, Traits and Enums

OpenApiAttributeInterface

Table of Contents

$extensions  : array<string|int, mixed>
$externalDocs  : ExternalDocumentation|null
$info  : Info|null
$security  : array<string|int, mixed>
$servers  : array<string|int, mixed>
$tags  : array<string|int, mixed>
__construct()  : void

Properties

Methods

__construct()

public __construct([Info|null $info = null ][, array<string|int, Tag> $tags = [] ][, array<string|int, Server> $servers = [] ][, array<string|int, SecurityRequirement> $security = [] ][, ExternalDocumentation|null $externalDocs = null ][, array<string|int, Extension> $extensions = [] ]) : void
Parameters
$info : Info|null = null

Provides metadata about the API. The metadata MAY be used by tooling as required.

$tags : array<string|int, Tag> = []

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools.

$servers : array<string|int, Server> = []

An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

$security : array<string|int, SecurityRequirement> = []

A declaration of which security mechanisms can be used across the API.

$externalDocs : ExternalDocumentation|null = null

Any additional external documentation for the API.

$extensions : array<string|int, Extension> = []

The list of optional extensions.

Return values
void —

Search results