npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@leoscope/openapi-request-validator

v1.0.0

Published

Validate request properties against an OpenAPI spec.

Downloads

109

Readme

openapi-request-validator NPM version Downloads Build Status Coveralls Status Gitter chat

Validate request properties against an OpenAPI spec.

Highlights

Example

See ./test/data-driven/*.js for more examples.

var OpenAPIRequestValidator = require('openapi-request-validator').default;
var requestValidator = new OpenAPIRequestValidator({
  parameters: [
    {
      in: 'query',
      type: 'string',
      name: 'foo',
      required: true
    }
  ],
  requestBody: { // optional OpenApi v3 requestBodyObject
    content: {
      'application/json': {
        schema: {
          properties: {
            name: {
              type: 'string'
            }
          }
        }
      }
    }
  },
  schemas: null, // an optional array or object of jsonschemas used to dereference $ref
  errorTransformer: null, // an optional transformer function to format errors
  customFormats: {
    // support `"format": "foo"` for types.
    foo: function(input) {
      return input === 'foo';
    }
  }
});

var request = {
  headers: {
    'content-type': 'application/json'
  },
  body: {},
  params: {},
  query: {foo: 'wow'}
};
var errors = requestValidator.validateRequest(request);
console.log(errors); // => undefined

API

validate(args)

args.parameters

An array of openapi parameters.

args.schemas

If given as an array, each schema must have an id property. See ./test/data-driven/ for tests with schemas. Ids may be schema local (i.e. #/definitions/SomeType), or URL based (i.e. /SomeType). When supplied, $ref usage will map exactly to the Id e.g. if id is /SomeType, $ref must be /SomeType.

If given as an object, it will be assigned to bodySchema.definitions. Schemas may then be dereferenced in parameters by using #/definitions/<key in args.schemas object>.

args.version

An optional string that currently does nothing. This will ensure nothing breaks for new versions of openapi drafts that get added in the future.

args.errorTransformer

A function that transforms errors.

This function is passed 2 arguments.

  errorTransformer: function(openapiError, ajvError) {
    return {
      message: openapiError.message
    };
  }

See the error format in ajv for ajvError. openapiErrors have the following properties:

  • errorCode - A jsonschema error suffixed with .openapi.requestValidation.
  • location - One of body, headers, path, or query. Signifies where validation failed.
  • message - A detailed message as to why validation failed.
  • path - The property of the location that failed validation.

args.customFormats

An object of formatters to use for the format keyword.

See Custom Formats in jsonschema.

LICENSE

The MIT License (MIT)

Copyright (c) 2018 Kogo Software LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.