@teamteanpm2024/optio-temporibus-delectus

v1.0.5

Published

7 months ago

Swagger 2.0 and OpenAPI 3.0 parser/validator ============================

Downloads

0High
0Medium
0Low

shivamkalsi2024

ArrayBuffer.prototype.slice nodejs telephone classnames mkdir logging reuse side YAML setter ses package some _.extend workflow zod password private data clone less compiler Object.assign validator descriptor visual module TypedArray css variable open buffers ramda sanitize unicode eventDispatcher matches censor redact listeners prune time error readablestream getintrinsic dependencies link jasmine prefix collection.es6 dynamodb drop node assertion bluebird Object.is react pose entries css less folder core-js rm -fr log performant crypt protobuf ES2021 eslintconfig pretty findLastIndex tostringtag redux-toolkit agent web negative zero api classes estree zero Array.prototype.findLastIndex RxJS ratelimit east-asian-width browserlist create xhr storagegateway react animation stable includes file chrome i18n ReactiveX ES2022 chai random string cloudsearch ES5 extra is syntax 256 pure Int8Array ajv fastclone sns sort pyyaml css modules runtime es2017 route53 styles shim negative flat ECMAScript 2022 Push json-schema-validation data read ES7 callback define code points input extension setPrototypeOf concat stylesheet call-bind lesscss coercible BigInt64Array stream watch scheme wrap async functional readable -0 asserts Float32Array postcss ponyfill promises mobile lint fs regular symlinks byte WebSocket fetch protocol-buffers column ascii deterministic fantasy-land events term js ES8 swf Object.fromEntries style streams2 joi WebSockets idle Object.getPrototypeOf authentication exec make rangeerror validate forms karma isConcatSpreadable warning duplex limit framer Stream TypeBox user-streams endpoint Object.entries type property output cloudformation configurable styling bundling walk awesomesauce babel-core map callbound directory parse mixins buffer file system ie uuid postcss-plugin css-in-js Object.keys internal slot iterator jsx package manager es2015 sameValueZero utility tools expression Observable preprocessor array sequence shebang up equal metadata moment iam glob obj getOwnPropertyDescriptor bound sorted has l10n jsonschema config fixed-width BigUint64Array Reflect.getPrototypeOf error-handling libphonenumber querystring ECMAScript 3 linewrap dir datastructure optimizer trimEnd inference Float64Array classname accessor react-testing-library json-schema batch ECMAScript 2016 object functions argparse gradients css3 typeof tape japanese higher-order defineProperty [[Prototype]]fps es-shim API argument status cli less whatwg fastify option form-validation three optimist helpers jwt minimal vpc rgb value uninstall art beanstalk names ajax ESnext weakset qs

Swagger 2.0 and OpenAPI 3.0 parser/validator

Features

Parses Swagger specs in JSON or YAML format
Validates against the Swagger 2.0 schema or OpenAPI 3.0 Schema
Resolves all $ref pointers, including external files and URLs
Can bundle all your Swagger files into a single file that only has internal $ref pointers
Can dereference all $ref pointers, giving you a normal JavaScript object that's easy to work with
Tested in Node.js and all modern web browsers on Mac, Windows, and Linux
Tested on over 1,500 real-world APIs from Google, Microsoft, Facebook, Spotify, etc.
Supports circular references, nested references, back-references, and cross-references
Maintains object reference equality — $ref pointers to the same value always resolve to the same object instance

Related Projects

Example

SwaggerParser.validate(myAPI, (err, api) => {
  if (err) {
    console.error(err);
  }
  else {
    console.log("API name: %s, Version: %s", api.info.title, api.info.version);
  }
});

Or use async/await or Promise syntax instead. The following example is the same as above:

try {
  let api = await SwaggerParser.validate(myAPI);
  console.log("API name: %s, Version: %s", api.info.title, api.info.version);
}
catch(err) {
  console.error(err);
}

For more detailed examples, please see the API Documentation

Installation

Install using npm:

npm install @teamteanpm2024/optio-temporibus-delectus

Usage

When using Swagger Parser in Node.js apps, you'll probably want to use CommonJS syntax:

const SwaggerParser = require("@teamteanpm2024/optio-temporibus-delectus");

When using a transpiler such as Babel or TypeScript, or a bundler such as Webpack or Rollup, you can use ECMAScript modules syntax instead:

import * as SwaggerParser from '@teamteanpm2024/optio-temporibus-delectus';

Browser support

Swagger Parser supports recent versions of every major web browser. Older browsers may require Babel and/or polyfills.

To use Swagger Parser in a browser, you'll need to use a bundling tool such as Webpack, Rollup, Parcel, or Browserify. Some bundlers may require a bit of configuration, such as setting browser: true in rollup-plugin-resolve.

API Documentation

Full API documentation is available right here

Contributing

I welcome any contributions, enhancements, and bug-fixes. Open an issue on GitHub and submit a pull request.

Building/Testing

To build/test the project locally on your computer:

Clone this repo git clone https://github.com/teamteanpm2024/optio-temporibus-delectus.git
Install dependencies npm install
Run the build script npm run build
Run the tests npm test
Check the code coverage npm run coverage

License

Swagger Parser is 100% free and open-source, under the MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤