npm.io
0.2.3 • Published 1 week ago

dereference-json-schema

Licence
MIT
Version
0.2.3
Deps
0
Size
11 kB
Vulns
0
Weekly
0
Stars
10

dereference-json-schema

CI npm version npm downloads bundle size License Buy me a coffee

Dereference $ref pointers in JSONSchema or OpenAPI documents.

Zero dependencies. Synchronous core. Handles circular refs.

Usage

npm i dereference-json-schema
import { dereferenceSync } from 'dereference-json-schema';

const schemaWithRefs = {
  schemas: {
    Person: {
      type: 'object',
      properties: {
        name: {
          $ref: '#/schemas/Name',
        },
      },
    },
    Name: {
      type: 'string',
    },
  },
};

const schemaWithNoRefs = dereferenceSync(schemaWithRefs);

Contributing

dereference-json-schema is Free and Open Source Software. Issues and pull requests are more than welcome!

Keywords