Application API Documentation

Directional Consulting

Search Documentation

Classes

RenderOpenApi in package

Table of Contents

HTML  = 'html'
JSON  = 'json'
YAML  = 'yaml'
$generatorLocator  : ContainerInterface
$openApiRenderers  : array<string, \Nelmio\ApiDocBundle\Render\OpenApiRenderer|null>
__construct()  : mixed
getAvailableFormats()  : array<string|int, mixed>
render()  : string
renderFromRequest()  : mixed

Constants

Properties

$generatorLocator

private ContainerInterface $generatorLocator

$openApiRenderers

private array<string, \Nelmio\ApiDocBundle\Render\OpenApiRenderer|null> $openApiRenderers = []

Methods

__construct()

public __construct(ContainerInterface $generatorLocator, OpenApiRenderer|null ...$openApiRenderers) : mixed
Parameters
$generatorLocator : ContainerInterface
$openApiRenderers : OpenApiRenderer|null
Return values
mixed —

getAvailableFormats()

public getAvailableFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

render()

public render(string $format, string $area[, array<string|int, mixed> $options = [] ]) : string
Parameters
$format : string
$area : string
$options : array<string|int, mixed> = []
Tags
throws
InvalidArgumentException

If the area to dump is not valid

Return values
string —

renderFromRequest()

public renderFromRequest(Request $request, string $format, mixed $area[, array<string|int, mixed> $extraOptions = [] ]) : mixed
Parameters
$request : Request
$format : string
$area : mixed
$extraOptions : array<string|int, mixed> = []
Return values
mixed — 

        

        
    




    

    

                    

    
Search Results

    

        

            
Search results

            
        

        

            
Found Results