swagger-node-runner

const express = require('express'); const SwaggerNodeRunner = require('swagger-node-runner'); const path = require('path'); const app = express(); const port = process.env.PORT || 3000; // Configuration for swagger-node-runner const config = { appRoot: __dirname, // Tells swagger-node-runner where to find controllers and fittings swaggerFile: path.resolve(__dirname, 'api', 'swagger', 'swagger.yaml'), // Example of a security handler configuration (uncomment and customize if needed) // swaggerSecurityHandlers: { // ApiKeyAuth: function (req, authOrSecDef, scopes, callback) { // // Simulate API key validation using an environment variable // if (req.headers['x-api-key'] === (process.env.API_KEY || 'your-secret-key')) { // callback(); // } else { // callback(new Error('Access denied: Invalid API Key')); // } // } // } }; SwaggerNodeRunner.create(config, function (err, runner) { if (err) { throw err; } // Install the Swagger Express middleware provided by the runner runner.expressMiddleware().register(app); // For Swagger UI, you would typically use a separate package (e.g., swagger-ui-express) // Example: app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(runner.swagger.parsed)); app.listen(port, function () { console.log(`Your API is running at http://localhost:${port}`); console.log(`Swagger UI (if configured separately) would be available at /api-docs`); }); }); // --- Minimal example files to make the above code runnable --- // Save this as api/swagger/swagger.yaml: /* swagger: '2.0' info: title: Example API version: '1.0.0' basePath: /v1 paths: /hello: x-swagger-router-controller: hello_world get: description: Returns 'Hello, World!' operationId: hello responses: '200': description: Success schema: type: string */ // Save this as api/controllers/hello_world.js: /* module.exports = { hello: function (req, res) { res.json('Hello, World!'); } }; */