example.js

var express = require('express')
, flair = require('./lib/index')
, joi = require('joi')
, flairui = require('flair-ui')
, app = express()
, cheeses = [
  { id: 1, name: 'edam' }
  , { id: 2, name: 'gouda' }
  , { id: 3, name: 'cheddar' }
  , { id: 4, name: 'emmental' }
];

function byId(value) {
  return function(item) {
    return item.id == value;
  };
}

//to validate against a json schema with a custom mime type we need
//this middleware
app.use(flair.jsonBodyParser());

//register our schema with flair
flair.addContentTypes([
  { 
    type: "application/vnd.cheese+json",
    schema: {
      id: "cheese",
      type: "object",
      properties: {
      name: {
        description: "The name of the cheese",
        type: "string",
        required: true
      },
        id: {
          description: "The id of the cheese",
          type: "integer",
          required: false //if a cheese has no id, we'll generate one
        }
      },
      //no null or undefined cheeses, thank you
      required: true
    }
  },
  { 
    type: "application/vnd.cheese-list+json",
    schema: {
      id: "cheeseList",
      type: "Array",
      items: { 
        //this reference will work in swagger, but not
        //real json-schema
        "$ref": "cheese"
      }
    }
  }
]);

app.get(
  '/cheese',
  flair.describe("cheeseList", "All cheeses", "Returns all the cheeses"),
  flair.produces("application/vnd.cheese-list+json"),
  function(req, res) {
    res.json(cheeses);
  }
);

app.post(
  '/cheese',
  flair.describe("createCheese", "Create cheese", "Adds a new cheese to the system"),
  flair.consumes("application/vnd.cheese+json"),
  function(req, res) {
    var newCheese = req.body;
    cheeses.push(newCheese);
    res.send(201);
  }
);

app.get(
  '/cheese/:id',
  flair.describe("getCheese", "Get cheese", "Returns a single cheese, selected by id"),
  flair.validate({
    id: joi.types.Number().integer().required().notes("path").description("cheese id")
  }),
  flair.produces("application/vnd.cheese+json"),
  function(req, res) {
    var cheese = cheeses.filter(byId(req.param("id")))[0];
    if (cheese) {
      res.header('content-type', 'application/vnd.cheese+json');
      res.json(cheese);
    } else {
      res.send(404);
    }
  }
);

app.put(
  '/cheese/:id',
  flair.describe("updateCheese", "Update cheese", "Update an existing cheese"),
  flair.validate({
    id: joi.types.Number().integer().required().notes("path").description("cheese id")
  }),
  flair.consumes("application/vnd.cheese+json"),
  function(req, res) {
    var cheese = cheeses.filter(byId(req.param("id")))[0];
    if (cheese) {
      cheese.name = req.body.name;
      res.json(cheese);
    } else {
      res.send(404);
    }
  }
);
    
app.use(flair.swagger(app, { 
  docPath: '/api-docs', 
  basePath: "http://localhost:3000/", 
  version: '0.1' 
}));
app.use('/docs', flairui('/api-docs', { supportHeaderParams: true }));
app.listen(3000);