bayfrontmedia/openapi-parser

PHP OpenAPI规范解析器

维护者

详细信息

github.com/bayfrontmedia/openapi-parser

主页

源代码

问题

安装: 2

依赖: 0

建议者: 0

安全: 0

星星: 1

关注者: 0

分支: 0

开放问题: 0

v1.0.1 2024-09-10 01:40 UTC

Requires

MIT 2ea40e1e5cca1c64f175605e34a22e188c27bae7

apiparseswaggeropenapibayfrontmedia

This package is auto-updated.

Last update: 2024-09-10 01:40:47 UTC

README

PHP OpenAPI规范解析器。

此库支持OAS 3.1，并解决内部OpenAPI规范引用。然后可以将OpenAPI规范解析成PHP对象。

许可证

该项目是开源的，可在MIT许可证下使用。

作者

Bayfront Media

要求

  • PHP >= 8.0

安装

composer require bayfrontmedia/opanapi-parser

用法

OpenApiSpec类用于将JSON和YAML文件解析成数组，并解决任何内部引用。

然后可以使用解析后的规范数组来创建一个OpenApiObject实例。所有OpenAPI对象类实例都实现了ObjectInterface。

ObjectInterface包括一个validate()方法，用于验证对OpenAPI规范的符合性，但所有验证函数目前都很基础，不应依赖。建议使用已测试为有效的OpenAPI规范。

注意：根据OpenAPI规范的大小，resolve方法可能相当慢。强烈建议将解析后的规范保存/缓存以用于生产。

示例

$spec = OpenApiSpec::parseJson(file_get_contents('openapi-specification.json')); // Parse JSON
$spec = OpenApiSpec::resolve($spec); // Resolve internal references (this file should be saved/cached)

$openapi = new OpenApiObject($spec); // Create new OpenApiObject using a resolved and valid OpenAPI specification

// Get PathItemObject for a single path
$path = $openapi->getPath('/auth/login');
$request = $path->getOperation($path::OPERATION_POST);

更多文档即将到来。