@amjs/api-openapi-reader

Reads an OpenAPI spec file and returns the whole extracted info

Usage no npm install needed!

<script type="module">
  import amjsApiOpenapiReader from 'https://cdn.skypack.dev/@amjs/api-openapi-reader';
</script>

README

@amjs/api-openapi-reader 0.1.2

Statements Branches Functions Lines

Reads an OpenAPI spec file and returns the whole extracted info

Installation

$ npm i @amjs/api-openapi-reader

Usage

const AmjsApiOpenApiReader = require('@amjs/api-openapi-reader');

const reader = new AmjsApiOpenApiReader('api-spec-path.yaml');
const output = reader.read().parse();
console.log(output); // { collections: [], items: [], paths: [] }

Notice

This package is integrated within @amjs/api-parser, which is highly suggested to use instead of this package on standalone.