Documentation

Specification
in package

Utility to load OpenAPI specifications

Table of Contents

Methods

from()  : OpenApi
Convenience method to read a variety of formats of OpenAPI spec
__construct()  : mixed
No instantiation

Methods

from()

Convenience method to read a variety of formats of OpenAPI spec

public static from(string $specification) : OpenApi
APIYes
Parameters
$specification : string

A descriptor of the specification. Either the path or URL of a JSON or YAML OpenAPI specification file (either absolute or relative to the current working directory), or a string literal containing either a JSON or YAML OpenAPI specification. If $specification is a path or URL, $resolveReferences defaults to true.

Tags
throws
ConfigurationException

if the $specification cannot be identified

Return values
OpenApi

The OpenApi object instance.

__construct()

No instantiation

private __construct() : mixed

        
On this page

Search results