danballance / oas-tools
PHP tools for working with Open API Specifications (version 2 and 3).
Requires
- php: >=7.2
- ext-json: *
- erusev/parsedown: ^1.7
- flow/jsonpath: ^0.4.0
- guzzlehttp/guzzle: ^6.3
- jshannon63/jsoncollect: ^1.2
- nicmart/tree: ^0.2.7
- symfony/yaml: ^4.1
- tightenco/collect: ^5.6
Requires (Dev)
- phpmd/phpmd: @stable
- phpunit/phpunit: ^8.1
- squizlabs/php_codesniffer: ^3.4
This package is auto-updated.
Last update: 2021-06-04 11:06:49 UTC
README
OAS Tools is a PHP library for working with Open API Specifications in both version 2 and version 3 formats.
The purpose of the library is to provide a more convenient interface for working with Open API specifications than manipulating arrays generated directly from the JSON or YAML files themselves. Over time the scope of the library will be improved to cover more of the schema and additional common use cases.
The current implementation provides a few initial features, including the ability to:
- easily load version 2 and 3 schemas from a file or network location and in JSON or YAML format
- query for lists of operations, operation ids and paths without having to parse the whole schema yourself
- query for schemas/definitions, optionally resolving all references
Installation
Use the package manager composer to install foobar.
composer require danballance/oas-tools
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.