allansun/openapi-parser

A universal OpenAPI (Swagger) schema parser

PHP OpenAPI (Swagger) parser

, _(*1)

A universal OpenAPI (V3) and Swagger (V2) schema parser that converts OpenAPI/Swagger files into PHP objects for programming use., _(*2)

Installing

composer require-dev allansun/openapi-parser

Usage

This project is intended for development environments only. It does not generate or provide any code for runtime environments. To start, _(*3)

<?php

    use OpenAPI\Parser;

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

The parser class will automatically detect input file type (JSON or YAML) and use correct parser (Swagger or OpenAPI) to parse the input., _(*4)

Alternatively, you can call the correct parser directly., _(*5)

<?php

    use OpenAPI\Parser\OpenAPIParser;

    $Parser = new OpenAPIParser();

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

Or to parse the legacy Swagger version, _(*6)

<?php

    use OpenAPI\Parser\SwaggerParser;

    $Parser = new SwaggerParser();

    $Swagger = $Parser->parse(json_decode(file_get_contents('swagger.json'), true));

The result would be:, _(*7)

, _(*8)

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us., _(*9)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*10)

Authors

• Allan Sun - Initial work - Allan Sun

See also the list of contributors who participated in this project., _(*11)

License

This project is licensed under the MIT License - see the LICENSE.md file for details, _(*12)