Simone-cogno / parse-server-swagger

parse server express middleware autogenerate api specs from parse server schemas

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

parse-server-swagger

V1 ROADMAP

Autogenerate parse server API swagger.json and swagger UI from Parse Server schemas.

Installation

    npm i parse-server-swagger -S

How to use ?

var ParseSwagger = require('parse-server-swagger');

// Serve swagger API documentation
if (CONFIG.swagger) {
    var parseSwagger = new ParseSwagger({
        host: 'http:localhost:1337',
        parsePath: '/parse'
        appId: '<appId>',
        masterKey: '<masterKey>',
    });

    app.use(parseSwagger);
}

Expose swagger UI here:

'/swagger'

Expose swagger.json here:

'/api-docs'

About

parse server express middleware autogenerate api specs from parse server schemas

License:MIT License


Languages

Language:JavaScript 100.0%