CuberL / easy-oas3-parser

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

License:MIT License


Languages

Language:TypeScript 100.0%