Giter Club home page Giter Club logo

swagger-validator's Introduction

grunt-swagger-checker

Grunt plugin for checking swagger syntax

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-swagger-checker --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-swagger-checker');

The "swagger_checker" task

Overview

This plugin uses Swagger parser. Please visit their website for any further implementation and documentation.

To use this plugin, navigate to your project's Gruntfile, add a section named swagger_checker to the data object passed into grunt.initConfig().

grunt.initConfig({
  swagger_checker: {
    options: {
      // Task-specific options go here.
    }
  },
});

Options

  • path: the file path or URL of your Swagger document, with the base path is your grunt.js file.
  • validate: this option controls how the Swagger document is validated. It is an object with 2 keys which are schema and spec. Set schema to true to validate Swagger 2.0 Schema. Set spec to true to validate things that aren't covered by the schema, such as duplicate parameters, invalid MIME types, etc.

Usage Examples

  grunt.initConfig({
    swagger_validator: {
      options: {
        path: './doc/REST_API/swagger/swagger.json',
        validate: {
          schema: true,
          spec: false
        }
      }
    }
  });

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

swagger-validator's People

Contributors

billyfrost418 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.