intros-swagger-tools

0.0.3 • Public • Published

Features

  • Simple CLI
    • Validate Swagger document(s)
    • Convert Swagger 1.2 documents to Swagger 2.0
  • Schema validation: For the file(s) supported by the Swagger specification, ensure they pass structural validation based on the [JSON Schema][json-schema] associated with that version of the specification (Browser and Node)
  • Semantic validation: Validates Swagger files above and beyond the structure of the file (Browser and Node)
  • Connect middleware for adding pertinent Swagger information to your requests (Node only)
  • Connect middleware for wiring up security handlers for requests based on Swagger documentation (Node only)
  • Connect middleware for wiring request handlers to requests based on Swagger documentation (Node only)
  • Connect middleware for serving your Swagger documents and [Swagger UI][swagger-ui] (Node only)
  • Connect middleware for using Swagger resource documents for pre-route validation (Node only)
    • Validate the request/response Content-Type based on the operation's consumes/produces value(s)
    • Validate the request parameter types
    • Validate the request parameter values
    • Validate the response values

Installation

Intros Swagger Tools is available for both Node.js and the browser. Installation instructions for each environment are below.

Browser

Installation for browser applications can be done via [Bower][bower] or by downloading a standalone binary.

Using Bower

bower install intros-swagger-tools --save

Node.js

Installation for Node.js applications can be done via [NPM][npm].

npm install intros-swagger-tools --save

If you want to use the intros-swagger-tools executable for validating Swagger documents, you can install intros-swagger-tools globally using the following:

npm install -g intros-swagger-tools

Documentation

intros-swagger-tools is heavily documented so head on over to the project [documentation][documentation] or jump straight to the [Quick Start][quick-start].

Package Sidebar

Install

npm i intros-swagger-tools

Weekly Downloads

4

Version

0.0.3

License

none

Last publish

Collaborators

  • intros