Classes
ApiDocGenerator
in package
Uses
LoggerAwareTrait
Table of Contents
- $alternativeNames : array<string|int, string>
- $cacheItemId : string|null
- $cacheItemPool : CacheItemPoolInterface|null
- $describers : iteratable<string|int, mixed>|array<string|int, DescriberInterface>
- $mediaTypes : array<string|int, string>
- $modelDescribers : iteratable<string|int, mixed>|array<string|int, ModelDescriberInterface>
- $openApi : OpenApi
- __construct() : mixed
- generate() : OpenApi
- setAlternativeNames() : mixed
- setMediaTypes() : mixed
Properties
$alternativeNames
private
array<string|int, string>
$alternativeNames
= []
$cacheItemId
private
string|null
$cacheItemId
$cacheItemPool
private
CacheItemPoolInterface|null
$cacheItemPool
$describers
private
iteratable<string|int, mixed>|array<string|int, DescriberInterface>
$describers
$mediaTypes
private
array<string|int, string>
$mediaTypes
= ['json']
$modelDescribers
private
iteratable<string|int, mixed>|array<string|int, ModelDescriberInterface>
$modelDescribers
$openApi
private
OpenApi
$openApi
Methods
__construct()
public
__construct(array<string|int, DescriberInterface>|iteratable<string|int, mixed> $describers, array<string|int, ModelDescriberInterface>|iteratable<string|int, mixed> $modelDescribers[, CacheItemPoolInterface $cacheItemPool = null ][, string $cacheItemId = null ]) : mixed
Parameters
- $describers : array<string|int, DescriberInterface>|iteratable<string|int, mixed>
- $modelDescribers : array<string|int, ModelDescriberInterface>|iteratable<string|int, mixed>
- $cacheItemPool : CacheItemPoolInterface = null
- $cacheItemId : string = null
Return values
mixed —generate()
public
generate() : OpenApi
Return values
OpenApi —setAlternativeNames()
public
setAlternativeNames(array<string|int, mixed> $alternativeNames) : mixed
Parameters
- $alternativeNames : array<string|int, mixed>
Return values
mixed —setMediaTypes()
public
setMediaTypes(array<string|int, mixed> $mediaTypes) : mixed
Parameters
- $mediaTypes : array<string|int, mixed>