Class SwaggerController

web_server/config/swagger_controller.js:24–87

export default class SwaggerController {
    constructor(envConfig) {
        // swagger definition
        const swaggerDefinition = {
            info: {
                title: 'MARINUS REST API',
                version: '1.0.0',
                description: 'Marinus APIs. ' +
                    'Login to Marinus via /login or use a valid apiKey to ' +
                    'authenticate and authorise the API calls.'
            },
            host: envConfig.swagger.hostname,
            basePath: '/',
            schemes: ['https']
        };

        // options for the swagger docs
        const options = {
            // import swaggerDefinitions
            swaggerDefinition: swaggerDefinition,
            // path to the API docs
            // The following routes can be added if needed
            //    './routes/admin.js',
            //    './routes/censys.js',
            apis: [
                './routes/cloud_services.js',
                './routes/ct.js',
                './routes/dns.js',
                './routes/graphs.js',
                './routes/iblox.js',
                './routes/sonar.js',
                './routes/tpds.js',
                './routes/tracked_scans.js',
                './routes/virustotal.js',
                './routes/whois_db.js',
                './routes/zones.js',
            ],
        };

        // initialize swagger-jsdoc
        this._swaggerSpec = swaggerJSDoc(options);

        // Errors
        this._swaggerSpec.definitions.BadInputError = Error400;
        this._swaggerSpec.definitions.ResultsNotFound = Error404;
        this._swaggerSpec.definitions.ServerError = Error500;

        // Valid responses
        this._swaggerSpec.definitions.CountResponse = CountResponse;

        // Common defintions
        this._swaggerSpec.securityDefinitions.APIKeyHeader = APIKeyHeader;
    }

    setup(app, express) {
        app.use('/docs/media', express.static('node_modules/swagger-ui-dist'));
        app.use('/docs/', express.static('views/swagger/'));