This module generates customizable swagger 2.0 definitions for your Baucis API.
Use this module in conjunction with Baucis.
Install with:
npm install --save baucis baucis-swagger2
It is very easy to use. Include the package after baucis is included, and before your API is built.
var express = require('express');
var baucis = require('baucis');
var apiDoc = require('baucis-swagger2');
var app = express();
// ... Set up a mongoose schema ...
baucis.rest('vegetable');
app.use('/api', baucis());
Then, access e.g. GET http://localhost:3333/api/swagger.json. See the Baucis repo for more information about building REST APIs with Baucis.
Change the test/fixures/config.json to point to a valid mongodb database.
Then run:
npm test
If you want to modify the swagger definition, generate the definition first. (This will happen automatically otherwise.)
Use the swagger2 member of the controller to extend paths and definitions per controller.
controller.generateSwagger2();
controller.swagger2.paths.xyz = '123';
controller.swagger2.definitions.xyz = {};Or use the swagger2Document of the baucis instance module to access and modify dirrecty the full swagger document after calling generateSwagger() on the API.
var baucisInstance = baucis();
//generate standard template for Swagger 2
baucisInstance.generateSwagger2();
//extend Swagger2 definitions
baucisInstance.swagger2Document.info.title = "myApi";
baucisInstance.swagger2Document.host = "api.weylandindustries.com:5000";
app.use('/api', baucisInstance);This module is an evolution of the great baucis-swagger addressing swagger version 1.0. This version is a fork of the previous one to provide an API description compliant with the Swagger 2.0 Specs
After talking with @wprl, We decided to fork to keep codebase small and maintainable for both versions.
In case you want to provide an easy transition as possible for your current API clients. You can expose both API descriptions at the same time including both modules:
var express = require('express');
var baucis = require('baucis');
var swagger = require('baucis-swagger');
var swagger2 = require('baucis-swagger2');
var app = express();
// ... Set up a mongoose schema ...
baucis.rest('vegetable');
app.use('/api', baucis());
After that:
- Swagger 1.1 doc will be exposed in
/api/documentation - Swagger 2.0 doc will be exposed in
/api/swagger.json
© 2014-2015 Icinetic