OpenAPI dereference

Dereference $ref pointers in JSONSchema or OpenAPI documents.

Zero dependencies. Synchronous core. Handles circular refs.

Installation

npm install @hckrnews/openapi-dereference or yarn add @hckrnews/openapi-dereference

Test the package

npm run test or yarn test

How to use

1npm i @hckrnews/openapi-dereference
2

1import { dereferenceSync } from '@hckrnews/openapi-dereference';
2
3const schemaWithRefs = {
4  schemas: {
5    Person: {
6      type: 'object',
7      properties: {
8        name: {
9          $ref: '#/schemas/Name',
10        },
11      },
12    },
13    Name: {
14      type: 'string',
15    },
16  },
17};
18
19const schemaWithNoRefs = dereferenceSync(schemaWithRefs);