node-OpenDroneMap/docs/generateSwaggerAPI.js at master · y1026/node-OpenDroneMap · GitHub

47 lines (41 loc) · 1.51 KB

Node-OpenDroneMap Node.js App and REST API to access OpenDroneMap.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program. If not, see <http://www.gnu.org/licenses/>.

"use strict";

let swaggerJSDoc = require('swagger-jsdoc');

let fs = require('fs');

let packageJson = JSON.parse(fs.readFileSync('../package.json'));

let options = {

swaggerDefinition: {

info: {

title: packageJson.name,

version: packageJson.version,

description: packageJson.description,

license: {

name: packageJson.license

contact: {

name: packageJson.author

}

consumes: ["application/json"],

produces: ["application/json", "application/zip"],

basePath: "/",

schemes: ["http"]

apis: ['../index.js'], // Path to the API docs

};

// Initialize swagger-jsdoc -> returns validated swagger spec in json format

let swaggerSpec = swaggerJSDoc(options);

fs.writeFileSync('swagger.json', JSON.stringify(swaggerSpec));

Expand file tree