benmorel/openapi-schema-to-json-schema

Convert an OpenAPI schema object to a JSON Schema object

0.1.4 2020-12-10 16:06 UTC

This package is auto-updated.

Last update: 2024-03-14 02:35:00 UTC


README

A PHP library to convert an OpenAPI schema or parameter object to JSON Schema.

Build Status Coverage Status Latest Stable Version License

This is a port of the nodejs package by @mikunn.

It currently converts from OpenAPI 3.0 to JSON Schema Draft 4.

Why?

OpenAPI is a specification for describing RESTful APIs. OpenAPI 3.0 allows us to describe the structures of request and response payloads in a detailed manner. This would, theoretically, mean that we should be able to automatically validate request and response payloads. However, at the time of writing there aren't many validators around.

The good news is that there are many validators for JSON Schema, such as justinrainbow/json-schema. The bad news is that OpenAPI 3.0 is not entirely compatible with JSON Schema. The Schema object of OpenAPI 3.0 is an extended subset of JSON Schema Specification Wright Draft 00 with some differences.

The purpose of this project is to fill the gap by doing the conversion between these two formats.

Features

  • converts OpenAPI 3.0 Schema object to JSON Schema Draft 4
  • converts OpenAPI 3.0 Parameter object to JSON Schema Draft 4
  • deletes nullable and adds "null" to type array if nullable is true
  • supports deep structures with nested allOfs etc.
  • removes OpenAPI specific properties such as discriminator, deprecated etc. unless specified otherwise
  • optionally supports patternProperties with x-patternProperties in the Schema object

NOTE: $refs are not dereferenced. Use a dereferencer prior to using this package.

Installation

This library is installable via Composer:

composer require benmorel/openapi-schema-to-json-schema

Requirements

This library requires:

  • PHP 7.2 or later
  • the json extension

There is no dependency on third-party libraries.

Project status & release process

The current releases are numbered 0.x.y. When a non-breaking change is introduced (adding new methods, optimizing existing code, etc.), y is incremented.

When a breaking change is introduced, a new 0.x version cycle is always started.

It is therefore safe to lock your project to a given release cycle, such as 0.1.*.

If you need to upgrade to a newer release cycle, check the release history for a list of changes introduced by each further 0.x.0 version.

Converting an OpenAPI schema

Here's a small example to get the idea:

use BenMorel\OpenApiSchemaToJsonSchema\Convert;

$schema = json_decode(<<<'JSON'
    {
        "type": "string",
        "format": "date-time",
        "nullable": true
    }
JSON
);

$convertedSchema = Convert::openapiSchemaToJsonSchema($schema);

echo json_encode($convertedSchema, JSON_PRETTY_PRINT);

The example prints out:

{
    "type": [
        "string",
        "null"
    ],
    "format": "date-time",
    "$schema": "http:\/\/json-schema.org\/draft-04\/schema#"
}

Converting an OpenAPI parameter

OpenAPI parameters can be converted:

use BenMorel\OpenApiSchemaToJsonSchema\Convert;

$param = json_decode(<<<'JSON'
    {
        "name": "parameter name",
        "in": "query",
        "schema": {
            "type": "string",
            "format": "date"
        }
    }
JSON
);

$convertedSchema = Convert::openapiParameterToJsonSchema($param);

echo json_encode($convertedSchema, JSON_PRETTY_PRINT);

The result is as follows:

{
    "type": "string",
    "format": "date",
    "$schema": "http:\/\/json-schema.org\/draft-04\/schema#"
}

When a parameter has several schemas (one per MIME type) a map is returned instead:

{
    "name": "parameter name",
    "in": "query",
    "content": {
        "application/javascript": {
            "schema": {
                "type": "string"
            }
        },
        "text/css": {
            "schema": {
                "type": "string"
            }
        }
    }
}

would be converted to:

{
    "application\/javascript": {
        "type": "string",
        "$schema": "http:\/\/json-schema.org\/draft-04\/schema#"
    },
    "text\/css": {
        "type": "string",
        "$schema": "http:\/\/json-schema.org\/draft-04\/schema#"
    }
}

Options

Both Convert::openapiSchemaToJsonSchema() and Convert::openapiParameterToJsonSchema() accept a $options associative array as the second argument, with the following keys:

cloneSchema (bool)

If set to false, converts the provided schema in place. If true, clones the schema by converting it to JSON and back. The overhead of the cloning is usually negligible. Defaults to true.

dateToDateTime (bool)

This is false by default and leaves date format as is. If set to true, sets format: 'date' to format: 'date-time'.

For example:

{
  "type": "string",
  "format": "date"
}

is converted to:

{
    "type": "string",
    "format": "date-time",
    "$schema": "http:\/\/json-schema.org\/draft-04\/schema#"
}

keepNotSupported (array)

By default, the following fields are removed from the result schema: nullable, discriminator, readOnly, writeOnly, xml, externalDocs, example and deprecated as they are not supported by JSON Schema Draft 4. Provide an array of the ones you want to keep (as strings) and they won't be removed.

removeReadOnly (bool)

If set to true, will remove properties set as readOnly. If the property is set as required, it will be removed from the required array as well. The property will be removed even if readOnly is set to be kept with keepNotSupported.

removeWriteOnly (bool)

Similar to removeReadOnly, but for writeOnly properties.

supportPatternProperties (bool)

If set to true and x-patternProperties property is present, change x-patternProperties to patternProperties and call patternPropertiesHandler. If patternPropertiesHandler is not defined, call the default handler. See patternPropertiesHandler for more information.

patternPropertiesHandler (function)

Provide a function to handle pattern properties and set supportPatternProperties to take effect. The function takes the schema where x-patternProperties is defined on the root level. At this point x-patternProperties is changed to patternProperties. It must return the modified schema.

If the handler is not provided, the default handler is used. If additionalProperties is set and is an object, the default handler sets it to false if the additionalProperties object has deep equality with a pattern object inside patternProperties. This is because we might want to define additionalProperties in OpenAPI spec file, but want to validate against a pattern. The pattern would turn out to be useless if additionalProperties of the same structure were allowed. Create you own handler to override this functionality.

See tests/PatternPropertiesTest.php for examples of how this works.