https://github.com/wolfchamane/amjs-api-openapi-reader

Reads an OpenAPI spec file and returns the whole extracted info
https://github.com/wolfchamane/amjs-api-openapi-reader

Last synced: 5 months ago
JSON representation

Reads an OpenAPI spec file and returns the whole extracted info

• Host: GitHub
• URL: https://github.com/wolfchamane/amjs-api-openapi-reader
• Owner: Wolfchamane
• License: mit
• Created: 2019-07-19T09:49:19.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T04:49:39.000Z (over 3 years ago)
• Last Synced: 2025-03-17T19:59:38.207Z (about 1 year ago)
• Language: JavaScript
• Size: 537 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @amjs/api-openapi-reader 0.1.2

![Statements](https://img.shields.io/badge/Statements-100%25-brightgreen.svg) ![Branches](https://img.shields.io/badge/Branches-100%25-brightgreen.svg) ![Functions](https://img.shields.io/badge/Functions-100%25-brightgreen.svg) ![Lines](https://img.shields.io/badge/Lines-100%25-brightgreen.svg)

> Reads an OpenAPI spec file and returns the whole extracted info

## Installation

```bash

$ npm i @amjs/api-openapi-reader

```

## Usage

```javascript

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](https://www.npmjs.com/package/@amjs/api-parser),

which is __highly__ suggested to use instead of this package on standalone.