northwoods/openapi

Tools for working with OpenAPI specifications

Maintainers

Details

github.com/northwoods/openapi

Source

Issues

Installs: 145

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 2

Forks: 0

Open Issues: 0

0.1.0 2018-11-20 16:48 UTC

Requires

  • php: ^7.2

Requires (Dev)

MIT f422891e935c0bf40a488284c73822b45b12895a

  • Woody Gilk <woody.gilk.woop@gmail.com>

jsonschematoolsconverterspecificationopenapijson-schema

This package is auto-updated.

Last update: 2024-12-21 21:47:29 UTC

README

Build Status Code Grade Code Coverage Latest Stable Version Total Downloads License

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.