Package Exports

@naturacosmeticos/api-linter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@naturacosmeticos/api-linter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@naturacosmeticos/api-linter

NPM

A comprehensive API linter for swagger files using OpenAPI 3.0 following Natura Cosmeticos best practices

Installation

# with npm
npm install --save @naturacosmeticos/api-linter

# with yarn
yarn add @naturacosmeticos/api-linter

Usage

const path = require('path');
const { validate } = require('@naturacosmeticos/api-linter');

const swaggerFile = path.join('path', 'to', 'swagger', 'file.yml');

const promise = validate(swaggerFile);

promise.then(faults => {
  console.log(faults);
}).catch(err => {
  console.error(err);
});