core\router\apidocs Class Reference

Public Member Functions
	openapi_docs (ResponseInterface $response,)
	Generate the API docs for the API.

Protected Member Functions
	get_api_docs_for_route (string $component, ReflectionClass $classinfo, specification $api, array $parentcontexts=[],)
	Get the API Docs for the specified Route.
	get_openapi_classes_names ()
	Get the list of OpenAPI Class Names.

Member Function Documentation

get_api_docs_for_route()

core\router\apidocs::get_api_docs_for_route ( string $component, ReflectionClass $classinfo, specification $api, array $parentcontexts = [] )

protected

Get the API Docs for the specified Route.

Parameters

string	$component	The component that the route relates to
ReflectionClass	$classinfo
specification	$api
array	$parentcontexts

Return values

self

get_openapi_classes_names()

core\router\apidocs::get_openapi_classes_names ( )

protected

Get the list of OpenAPI Class Names.

Return values

string[]

openapi_docs()

core\router\apidocs::openapi_docs

(

ResponseInterface

$response

)

Generate the API docs for the API.

Parameters

ResponseInterface

$response

Return values

ResponseInterface

---

The documentation for this class was generated from the following file:

• lib/classes/router/apidocs.php