swagger-express-mw

const express = require('express'); const swaggerExpressMw = require('swagger-express-mw'); const path = require('path'); const fs = require('fs'); // Create an Express app const app = express(); // Define your Swagger/OpenAPI 2.0 configuration const config = { appRoot: __dirname, // required config // You might place your swagger.yaml in './api/swagger/swagger.yaml' or specify a path. // For this example, we'll create a dummy one. swaggerFile: path.resolve(__dirname, 'api', 'swagger', 'swagger.yaml') }; // Ensure the directory for the swagger file exists const swaggerDir = path.dirname(config.swaggerFile); if (!fs.existsSync(swaggerDir)) { fs.mkdirSync(swaggerDir, { recursive: true }); } // Write a basic Swagger 2.0 YAML file for demonstration const swaggerYamlContent = ` swagger: "2.0" info: version: "1.0.0" title: "Hello API" paths: /hello: get: description: "Returns 'Hello {name}' to the caller" parameters: - name: "name" in: "query" description: "Name to greet" required: false type: "string" responses: 200: description: "Success" schema: type: "string" `; fs.writeFileSync(config.swaggerFile, swaggerYamlContent); // Initialize swagger-express-mw swaggerExpressMw.create(config, function(err, swaggerExpress) { if (err) { throw err; } // Install Swagger Express middleware into the Express app swaggerExpress.register(app); // Access the Swagger object for runtime configuration or documentation const swaggerObject = swaggerExpress.runner.swagger; console.log('Swagger API Title:', swaggerObject.info.title); // Define a simple controller for the /hello path // This would typically be in './api/controllers/hello_controller.js' // and linked via x-swagger-router-controller and operationId in swagger.yaml // For this quickstart, we'll handle it directly. app.get('/hello', (req, res) => { const name = req.query.name || 'Stranger'; res.send(`Hello, ${name}!`); }); // Start the server const port = process.env.PORT || 8000; app.listen(port, () => { console.log(`Server running on http://localhost:${port}`); console.log(`Try: http://localhost:${port}/hello?name=World`); console.log(`Swagger definition available at http://localhost:${port}/swagger`); }); });