README

这个库旨在与其他 Membrane 库一起使用。

它使用一些额外的验证包装了 php-openapi 库，包括 Membrane 特定的要求。

需求

有效的 OpenAPI 规范。
所有操作对象上都有一个 operationId，以便每个路由都可以唯一标识。

安装

composer require membrane/openapi-router

快速入门

实例化一个 Reader

$versions = [\Membrane\OpenAPIReader\OpenAPIVersion::Version_3_0];

$reader = new \Membrane\OpenAPIReader\Reader($versions);

从绝对文件路径读取

此方法是读取器的主要用例，能够 解析所有引用。

如果您的文件路径包含文件扩展名，则读取器可以使用此信息来确定 OpenAPI 编写的语言。

// code to instantiate reader... 

$reader->readFromAbsoluteFilePath('~/path/to/my-openapi.yaml');

否则，您可以通过提供第二个参数确保将其作为特定格式读取

// code to instantiate reader... 

$fileFormat = \Membrane\OpenAPIReader\FileFormat::Json;

$reader->readFromAbsoluteFilePath('my-openapi', $fileFormat);

从字符串读取

此方法只能解析引用对象，不能解析对相对文档的引用。

因为 OpenAPI 将从字符串读取，所以必须提供 FileFormat。

// code to instantiate reader... 

$myOpenAPI = '<Insert your OpenAPI Spec here>';
$fileFormat = \Membrane\OpenAPIReader\FileFormat::Json;

$reader->readFromString($myOpenAPI, $fileFormat)

membrane / openapi-reader

维护者

详情

README

需求

安装

快速入门

实例化一个 Reader

从绝对文件路径读取

从字符串读取