README

Parse (and maybe one day write) OpenAPI files in PHP.

For now, it's strict and is not intended to support invalid specification files. Please ensure you validate them before parsing with this library.

Installation

composer require adamquaile/openapi-parser

Usage

Here's an example usage of the library. Check ./tests/Feature for more examples.

<?php

use AdamQ\OpenApiParser\OpenApiParser;

$openapiParser = new OpenApiParser();
$openapi = $openapiParser->parseYamlString(
    file_get_contents('openapi.yaml')
);

echo $openapi->info->version;

Compatibility

This library is not yet at version 1.0, so all of the following may change at any time.

PHP Version Support

This library aims to support any PHP version under active support and any versions that are not end-of life where possible. Support for new versions may require a new major version, at which point EOL versions will be dropped.

OpenAPI Version Support

This library is being developed at a time when OpenAPI 3.1 is already quite widely-used. There's a lot to cover in creating this project, so 3.0 support is not a priority. Pull requests will be considered and 3.0 support is the goal, but efforts will be focused on later versions.

OpenAPI Feature Support (How complete is this library)

Footnotes

1. Specification Extensions support missing ↩

2. RuntimeExpressions are not automatically resolved in CallbackObjects ↩

3. Full OpenAPI 3.0 support missing ↩