Noiseless Praying Mantis
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

baucis-openapi3

0.2.5 • Public • Published

baucis-openapi3

Build Status Coverage Status Dependency Status bitHound Overall Score Known Vulnerabilities npm version

NPM

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

Usage

Install with:

npm install --save baucis baucis-openapi3

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-openapi3');
 
    var app = express();
 
    // ... Set up a mongoose schema ...
 
    baucis.rest('vegetable');
    app.use('/api', baucis());

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

Tests

Change the test/fixures/config.json if needed, to point to a valid mongodb database. Then run:

npm test

Extensibility

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

Use the openApi3 member of the controller to extend paths and components per controller.

controller.generateOpenApi3();
controller.openApi3.paths.xyz = '123';
controller.openApi3.components.schemas.xyz = {};

Or use the openApi3Document of the baucis instance module to access and modify dirrecty the full document after calling generateOpenApi3() on the API.

var baucisInstance = baucis();
 
//generate standard template for OpenAPI3
baucisInstance.generateOpenApi3();
//extend OpenAPI3 definitions
baucisInstance.openApi3Document.info.title = "myApi";
 
app.use('/api', baucisInstance);

Backward compatibility

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 openapi3 = require('baucis-openapi3');
 
    var app = express();
 
    // ... Set up a mongoose schema ...
 
    baucis.rest('vegetable');
    app.use('/api', baucis());

After that:

  • Swagger 1.1 doc will be exposed at /api/documentation
  • Swagger 2.0 doc will be exposed at /api/swagger.json
  • OpenAPI 3.0 doc will be exposed at /api/openapi.json

Contact

© 2017 Metadev

install

npm i baucis-openapi3

Downloadsweekly downloads

1

version

0.2.5

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar