Documentation

Developer
in package

Developer class tools for installer.

Table of Contents

PATH  = '/api/doc'
generateSwagger()  : string
Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations.
generateSwaggerByType()  : string
Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations by type.

Constants

PATH

public string PATH = '/api/doc'

Default path

Methods

generateSwagger()

Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations.

public static generateSwagger([string $path = self::PATH ]) : string
Parameters
$path : string = self::PATH
Return values
string

generateSwaggerByType()

Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations by type.

public static generateSwaggerByType(string $type[, string $path = self::PATH ][, bool $errorHandler = true ]) : string
Parameters
$type : string
$path : string = self::PATH
$errorHandler : bool = true
Return values
string

        

Search results