node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

swagger-framework

Swagger Framework Build Status

Swagger Framework is a module for creating Swagger Specification validated web resources using the standard Node HTTP request listener interface.

It validates and normalizes incoming requests, validates Swagger Specification, and generates the documentation endpoints.

Documentation

### Class: swagger.Framework(spec, [options])

Declares a Framework using the Swagger API Resource Listing specification.

You should not include the apis attribute.

This acts as a container for all the API's and contains helper methods for serving HTTP resources and the documentation endpoints.

#### framework.setup()

Validates resources attached to framework. This is automatically called by framework.dispatcher and framework.server.

#### framework.api(spec, [options])

Declares and attaches Api class.

#### framework.api(api)

Attaches Api instance.

#### framework.dispatcher([options])

Returns a function that implements the Node HTTP requestListener interface.

It also supports the Express/Connect style next argument.

Example (Express)

app.use('/api-docs', framework.docs.dispatcher());
app.use('/', framework.dispatcher());
#### framework.server([options])

Returns an http.Server instance which serves API's on / and the documentation endpoint on /api-docs.

Example

framework.server().listen(8000);
### Class: swagger.Api(spec, [options])

Declares an Api using the Swagger API Declaration specification.

You should not include the apis attribute.

#### api.resource(spec, [options])

Declares and attaches Resource class.

#### api.resource(resource)

Attaches Resource instance.

#### api.model(spec)

Declares a Model using the Swagger Model Object specification.

### Class: swagger.Resource(spec, [options])

Declares a Resource using the Swagger API Object specification.

You should not include the operations attribute.

#### resource.operation(spec, [options], [callback])

Declares and attaches Operation class.

#### resource.operation(operation)

Attaches Operation instance.

### Class: swagger.Operation(spec, [options], [callback...])

Declares an Operation using the Swagger Operation Object specification.

### Request Handler

The Operation class takes a callback that will be called when an HTTP request matches the declared API, Resource, Operation, and passes all validation checks.

This function has an Express-style signature (function(req, res, next)) where req and res are standard Node http objects (or whatever your framework passes it). next is a callback that can be called to skip the current handler, or with an Error parameter to stop execution and activate the error handler. If you're using a framework (i.e. Express) that supports next then calls will proprogate back to the framework.

### sf

This object is attached to the req and res instances. It is used to pass state between middleware and includes helper functions.

#### sf.accept

This is an Accepts instance.

#### sf.body

This is an object of body values. It has already been validated and normalized against the Swagger specification.

Additional values are discarded unless the removeBody option is set to false.

#### sf.form

This is an object of form values. It has already been validated and normalized against the Swagger specification.

Additional values are discarded unless the removeForm option is set to false.

#### sf.header

This is an object of headers. It has already been validated and normalized against the Swagger specification.

Additional headers are discarded unless the removeHeader option is set to false.

#### sf.path

This is an object of path segments. It has already been validated and normalized against the Swagger specification.

#### sf.produce #### sf.reply([statusCode], [body])

This formats and replies to the HTTP request.

statusCode should be a numeric HTTP response code (defaults to 200).

body should be the response content.

#### sf.reply([statusCode], err)

This formats and replies to the HTTP request.

statusCode should be a numeric HTTP response code (defaults to 500).

err should be an instance of Error. If err.statusCode is defined it will be used as the return status code. If err.expose is truthy then err.toJSON() (if defined) or err.message will be set as the response body.

#### Callback: sf.responseMessage(reply)

This is a callback that you can attach to the sf attribute to format reply calls.

reply will be an object that contains statusCode, body, and args. statusCode and body are the response attributes that reply interpreted from the caller. args is an array of the actual arguments.

responseMessage should either return an object with statusCode and body, or a falsy value and handle the response itself.

#### sf.query

This is an object of query parameters. It has already been validated and normalized against the Swagger specification.

Additional query parameters are discarded unless the removeQuery option is set to false.

#### sf.url

This is a URL object for the resource.

Example

See more in the examples directory.

var swagger = require('swagger-framework');
 
var host = '127.0.0.1';
var port = 8000;
var url = 'http://' + host + ':' + port;
 
var framework = swagger.Framework({ basePath: url });
 
var api = framework.api({
  path: '/pet',
  description: 'Manage pets',
  consumes: ['application/json'],
  produces: ['application/json'],
});
 
var resource = api.resource({ path: '/pet/{petId}' });
 
var operation = resource.operation(
  {
    method: 'GET',
    summary: 'Find pet by ID',
    notes: 'Returns a pet based on ID',
    type: 'Pet',
    nickname: 'getPetById',
    parameters: [
      {
        name: 'petId',
        description: 'ID of pet that needs to be fetched',
        required: true,
        type: 'integer',
        paramType: 'path',
        minimum: '1',
        maximum: '100000',
      },
    ],
    responseMessages: [
      {
        code: 400,
        message: 'Invalid ID supplied',
      },
      {
        code: 404,
        message: 'Pet not found',
      },
    ],
  },
  function(req, res) {
    res.sf.reply(200, {
      message: 'pet id ' + req.sf.path.petId,
    });
  }
);
 
api.model({
  id: 'Pet',
  required: ['id', 'name'],
  properties: {
    id: {
      type: 'integer',
      description: 'unique identifier for the pet',
      minimum: '0',
      maximum: '100',
    },
    name: {
      type: 'string'
    },
    photoUrls: {
      type: 'array',
      items: { type: 'string' },
    },
    status: {
      type: 'string',
      description: 'pet status in the store',
      enum: ['available', 'pending', 'sold'],
    },
  },
});
 
if (module.parent) {
  module.exports = framework;
} else {
  framework.server().listen(port, host, function(err) {
    if (err) throw err;
 
    console.log('Server started ' + url + '/');
  });
}

License

This work is licensed under the MIT License (see the LICENSE file).