northwoods/openapi

Tools for working with OpenAPI specifications

0.1.0 2018-11-20 16:48 UTC

Requires

• php: ^7.2

Requires (Dev)

• phpstan/phpstan: ^0.10.5
• phpstan/phpstan-phpunit: ^0.10.0
• phpunit/phpunit: ^7.3
• squizlabs/php_codesniffer: ^3.3

MIT

• Woody Gilk

• json
• schema
• tools
• converter
• specification
• openapi
• json-schema

README

Tools for working with OpenAPI specifications.

Installation

The best way to install and use this package is with composer:

composer require northwoods/openapi

Usage

Conversion

This package supports converting OpenAPI schemas to JSON Schema proper:

use Northwoods\OpenApi\Converter;

// See below for options
$converter = new Converter($options);

/** @var object */
$schema = /* load your schema */;

$schema = $converter->convert($schema);

Note that references are not resolved and only schemas can be converted. It is recommended that conversion is used in conjunction with justinrainbow/json-schema.

Options

The following options are available:

• boolean removeReadOnly remove all schemas with readOnly = true
• boolean removeWriteOnly remove all schemas with writeOnly = true
• string[] keepUnsupported do not remove these schema properties

Credits

The converter is based on the excellent openapi-to-json-schema package. Type/format conversions are influenced by this PHP port.