@coorpacademy/baucis-swagger

baucis-swagger

:warning: This is a fork from the Coorpacademy Tech team :warning:

This is so far intended for intern use

This module generates customizable swagger definitions for your Baucis API. Use this module in conjunction with Baucis.

npm install --save @coorpacademy/baucis @coorpacademy/baucis-swagger

It is very easy to use. Include the package after baucis is included, and before your API is built.

const express = require('express');
const baucis = require('@coorpacademy/baucis')(mongoose, express);
const swagger = require('@coorpacademy/baucis-swagger');

baucis.addPlugin(swagger)
const app = express();

// ... Set up a mongoose schema ...

baucis.rest('vegetable');
app.use('/api', baucis());

Then, access e.g. GET http://localhost:3333/api/documentation. See the Baucis repo for more information about building REST APIs with Baucis.

If you want to modify the swagger definition, generate the definition first. (This will happen automatically otherwise.)

controller.generateSwagger();
controller.swagger.xyz = '123';

If you wish to disable the Invalid type warning, you can load the plugin with the following options:

baucis.addPlugin(swagger.withOptions({noWarning: true}));