openapi-schema-validator
    TypeScript icon, indicating that this package has built-in type declarations

    12.0.0 • Public • Published

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

    A validator for OpenAPI documents.

    Supported OpenAPI versions

    • v3
    • v2 (formerly known as Swagger V2)

    Document examples and full specs:

    Highlights

    • Validate openapi documents against openapi schema documents.
    • Uses jsonschema under the hood.
    • Performant.
    • Currently supports type definitions included in the definitions property of the provided openapi document.
    • Extensively tested.
    • Small footprint.

    Huge thank you to the gnostic project for building up a 3.0.0 JSON schema.

    Example

    var OpenAPISchemaValidator = require('openapi-schema-validator').default;
    var validator = new OpenAPISchemaValidator({
      version: 2,
      // optional
      extensions: {
        /* place any properties here to extend the schema. */
      }
    });
    console.log(validator.validate(apiDoc));
    • version number openapi document schema version to use (2 or 3).
      • 2 - openapi-2.0.0 (default)
      • 3 - openapi-3.0.0

    see here for example results.

    API

    .validate(apiDoc)

    • apiDoc object is any api document you wish to validate.

    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.
    

    Install

    npm i openapi-schema-validator

    DownloadsWeekly Downloads

    159,922

    Version

    12.0.0

    License

    MIT

    Unpacked Size

    109 kB

    Total Files

    10

    Last publish

    Collaborators

    • jsdevel