allansun / openapi-parser
A universal OpenAPI (Swagger) schema parser
Installs: 7 759
Dependents: 92
Suggesters: 0
Security: 0
Stars: 10
Watchers: 2
Forks: 3
Open Issues: 0
Requires
- php: ^7.4|^8.0
- ext-fileinfo: *
- ext-json: *
- symfony/property-info: ^v5|^v6
- symfony/yaml: ^v5|^v6
Requires (Dev)
- phpunit/phpunit: ^9
README
A universal OpenAPI (V3) or Swagger (V2) schema parser to convert OpenAPI/Swagger files into PHP object for programming use.
Installing
composer require-dev allansun/openapi-parser
Usage
This project is used for 'dev' environment only. It does not generate/provide any codes for run-time environment.
To start
<?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.
Alternatively, you can call the correct parser directly.
<?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
<?php use OpenAPI\Parser\SwaggerParser; $Parser = new SwaggerParser(); $Swagger = $Parser->parse(json_decode(file_get_contents('swagger.json'), true));
The result would be:
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Allan Sun - Initial work - Allan Sun
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details