bhtz / parse-server-swagger

parse server express middleware autogenerate api specs from parse server schemas
MIT License
12 stars 9 forks source link

parse-server-swagger

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

Installation

    npm i parse-server-swagger -S

How to use ?

This assumes that Parse is initialized with a master key.


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

// Serve swagger API documentation
if (CONFIG.swagger) {
    const parseSwagger = new ParseSwagger();
    app.use(parseSwagger);
}

Expose swagger UI here:

'/api-docs'

Expose swagger.json here:

'/openapi.json'