easy-oas3-parser
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

easy-oas3-parser

Build Status Coverage Status License Version

Installation

Install to your projects

yarn add easy-oas3-parser

Usage

import Parser from 'easy-oas3-parser'
import * as fs from 'fs'

const schema = fs.readFileSync('example.json');
const schema_parsed = Parser(JSON.parse(schema.toString()))

// judge if it's an object
if (schema_parsed.isObject()) {
    // get properties of this object type node
    console.log(schema_parsed.properties);
    // get node by path
    console.log(schema_parsed.get('a.b.c'));
}

For more examples, take a look at /example

Know issues

  • All cases need to be arranged if oneOf appears in allOf. But it's too complex. Only one oneOf is allowed in allOf for now.

Readme

Keywords

none

Package Sidebar

Install

npm i easy-oas3-parser

Weekly Downloads

77

Version

0.2.0

License

MIT

Unpacked Size

23.2 kB

Total Files

25

Last publish

Collaborators

  • cuberl