allansun / openapi-parser

通用的OpenAPI (Swagger) schema解析器

维护者

详细信息

github.com/allansun/openapi-parser

源代码

问题

安装次数: 9,350

依赖项: 92

建议者: 0

安全: 0

星星: 11

关注者: 3

分支: 5

开放问题: 6

2.2 2024-09-22 12:38 UTC

Requires

Requires (Dev)

MIT 8cfc73372f7ff6921a0e429d4812371425979c2f

  • Allan Sun <allan.sun.woop@bricre.com>

This package is auto-updated.

Last update: 2024-09-22 13:28:37 UTC

README

Latest Stable Version Total Downloads License codecov

这是一个通用的OpenAPI (V3) 和 Swagger (V2) schema解析器，它将OpenAPI/Swagger文件转换为PHP对象以供编程使用。

安装

composer require-dev allansun/openapi-parser

使用方法

本项目仅适用于开发环境。它不会为运行时环境生成或提供任何代码。要开始

<?php

    use OpenAPI\Parser;
    
    $OpenAPI = Parser::parse('openapi.json');

解析器类将自动检测输入文件类型（JSON或YAML），并使用正确的解析器（Swagger或OpenAPI）来解析输入。

或者，您可以直接调用正确的解析器。

<?php

    use OpenAPI\Parser\OpenAPIParser;
    
    $Parser = new OpenAPIParser();
    
    $OpenAPI = $Parser->parse(json_decode(file_get_contents('openapi.json'), true));

或者解析旧版的Swagger版本

<?php

    use OpenAPI\Parser\SwaggerParser;
    
    $Parser = new SwaggerParser();
    
    $Swagger = $Parser->parse(json_decode(file_get_contents('swagger.json'), true));

结果将是

OpenAPI

贡献

请阅读CONTRIBUTING.md以了解我们的行为准则以及向我们提交pull请求的过程。

版本控制

我们使用SemVer进行版本控制。有关可用的版本，请参阅此存储库的标签。

作者

有关参与此项目的贡献者列表。

许可证

本项目采用MIT许可证 - 有关详细信息，请参阅LICENSE.md文件。