Wondering what’s next for npm?Check out our public roadmap! »

    @openapi-contrib/json-schema-to-openapi-schema
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.0 • Public • Published

    JSON Schema to OpenAPI Schema

    A little NodeJS package to convert JSON Schema to a OpenAPI Schema Object.

    Treeware

    Features

    • converts JSON Schema Draft 04 to OpenAPI 3.0 Schema Object
    • switches type: ['foo', 'null'] to type: foo and nullable: true
    • supports deep structures with nested allOfs etc.
    • switches patternProperties to x-patternProperties
    • converts dependencies to an allOf + oneOf OpenAPI-valid equivalent

    Installation

    npm install --save @openapi-contrib/json-schema-to-openapi-schema

    Requires NodeJS v10 or greater.

    Usage

    Here's a small example to get the idea:

    const convert = require('@openapi-contrib/json-schema-to-openapi-schema');
    
    const schema = {
      '$schema': 'http://json-schema.org/draft-04/schema#',
      type: ['string', 'null'],
      format: 'date-time',
    };
    
    (async () => {
      const convertedSchema = await convert(schema);
      console.log(convertedSchema);
    })();

    The example prints out

    {
      type: 'string',
      format: 'date-time',
      nullable: true
    }

    Options

    The function accepts options object as the second argument.

    cloneSchema (boolean)

    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.

    dereference (boolean)

    If set to true, all local and remote references (http/https and file) $refs will be dereferenced. Defaults to false.

    Why?

    OpenAPI is often described as an extension of JSON Schema, but both specs have changed over time and grown independently. OpenAPI v2 was based on JSON Schema draft v4 with a long list of deviations, but OpenAPI v3 shrank that list, upping their support to draft v4 and making the list of discrepancies shorter. This has been solved for OpenAPI v3.1, but for those using OpenAPI v3.0, you can use this tool to solve the divergence.

    Diagram showing data model (the objects, payload bodies, etc) and service model (endpoints, headers, metadata, etc)

    This tool sets out to allow folks to convert from JSON Schema (their one source of truth for everything) to OpenAPI (a thing for HTML docs and making SDKs).

    Versions

    † Draft v5 is also known as Draft Wright 00, as the drafts are often named after the author, and this was the first one by A. Wright. Amongst other things, draft v5 aimed to rewrite the meta files, but the experiment failed, meaning we need to continue to use the draft v4 metafiles. Ugh.

    Converting Back

    To convert the other way, check out openapi-schema-to-json-schema, which this package was based on.

    Tests

    To run the test-suite:

    npm test

    Treeware

    This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

    Thanks

    Keywords

    none

    Install

    npm i @openapi-contrib/json-schema-to-openapi-schema

    DownloadsWeekly Downloads

    5,726

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    92.6 kB

    Total Files

    41

    Last publish

    Collaborators

    • avatar