mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-10 19:12:42 +00:00
Nodejs express js packages update (#5675)
* Updated to new nodejs packages, depending heavily on express-openapi-validator. Requires quite a change in code. Updated the business-logic in the controllers/Controller.js file. Logger now records also timestamp of events. Files are uploaded according to definition in config.js file * Removed commented-out code; Changed openApi document extensions to suit new express-openapi-validator definition; multipart and file uploading is supported now; Automatic response returns the values the were sent in the request * fixed README documentation, fixed a mistage in package.json/mustache * added generated files that were created when running the ./bin/test file
This commit is contained in:
@@ -1,35 +1,43 @@
|
||||
// const { Middleware } = require('swagger-express-middleware');
|
||||
const http = require('http');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const swaggerUI = require('swagger-ui-express');
|
||||
const yamljs = require('yamljs');
|
||||
const jsYaml = require('js-yaml');
|
||||
const express = require('express');
|
||||
const cors = require('cors');
|
||||
const cookieParser = require('cookie-parser');
|
||||
const bodyParser = require('body-parser');
|
||||
const { OpenApiValidator } = require('express-openapi-validator');
|
||||
const openapiRouter = require('./utils/openapiRouter');
|
||||
const logger = require('./logger');
|
||||
const config = require('./config');
|
||||
|
||||
class ExpressServer {
|
||||
constructor(port, openApiYaml) {
|
||||
this.port = port;
|
||||
this.app = express();
|
||||
this.openApiPath = openApiYaml;
|
||||
this.schema = yamljs.load(openApiYaml);
|
||||
try {
|
||||
this.schema = jsYaml.safeLoad(fs.readFileSync(openApiYaml));
|
||||
} catch (e) {
|
||||
logger.error('failed to start Express Server', e.message);
|
||||
}
|
||||
this.setupMiddleware();
|
||||
}
|
||||
|
||||
setupMiddleware() {
|
||||
// this.setupAllowedMedia();
|
||||
this.app.use(cors());
|
||||
this.app.use(bodyParser.json());
|
||||
this.app.use(bodyParser.json({ limit: '14MB' }));
|
||||
this.app.use(express.json());
|
||||
this.app.use(express.urlencoded({ extended: false }));
|
||||
this.app.use(cookieParser());
|
||||
this.app.use('/spec', express.static(path.join(__dirname, 'api')));
|
||||
this.app.get('/hello', (req, res) => res.send('Hello World. path: '+this.openApiPath));
|
||||
// this.app.get('/spec', express.static(this.openApiPath));
|
||||
this.app.use('/api-docs', swaggerUI.serve, swaggerUI.setup(this.schema));
|
||||
//Simple test to see that the server is up and responding
|
||||
this.app.get('/hello', (req, res) => res.send(`Hello World. path: ${this.openApiPath}`));
|
||||
//Send the openapi document *AS GENERATED BY THE GENERATOR*
|
||||
this.app.get('/openapi', (req, res) => res.sendFile((path.join(__dirname, 'api', 'openapi.yaml'))));
|
||||
//View the openapi document in a visual interface. Should be able to test from this page
|
||||
this.app.use('/api-doc', swaggerUI.serve, swaggerUI.setup(this.schema));
|
||||
this.app.get('/login-redirect', (req, res) => {
|
||||
res.status(200);
|
||||
res.json(req.query);
|
||||
@@ -38,50 +46,31 @@ class ExpressServer {
|
||||
res.status(200);
|
||||
res.json(req.query);
|
||||
});
|
||||
}
|
||||
|
||||
launch() {
|
||||
new OpenApiValidator({
|
||||
apiSpecPath: this.openApiPath,
|
||||
}).install(this.app);
|
||||
this.app.use(openapiRouter());
|
||||
this.app.get('/', (req, res) => {
|
||||
res.status(200);
|
||||
res.end('Hello World');
|
||||
});
|
||||
}
|
||||
|
||||
addErrorHandler() {
|
||||
this.app.use('*', (req, res) => {
|
||||
res.status(404);
|
||||
res.send(JSON.stringify({ error: `path ${req.baseUrl} doesn't exist` }));
|
||||
});
|
||||
/**
|
||||
* suppressed eslint rule: The next variable is required here, even though it's not used.
|
||||
*
|
||||
** */
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
this.app.use((error, req, res, next) => {
|
||||
const errorResponse = error.error || error.errors || error.message || 'Unknown error';
|
||||
res.status(error.status || 500);
|
||||
res.type('json');
|
||||
res.json({ error: errorResponse });
|
||||
});
|
||||
}
|
||||
|
||||
async launch() {
|
||||
return new Promise(
|
||||
async (resolve, reject) => {
|
||||
try {
|
||||
this.addErrorHandler();
|
||||
this.server = await this.app.listen(this.port, () => {
|
||||
console.log(`server running on port ${this.port}`);
|
||||
resolve(this.server);
|
||||
apiSpec: this.openApiPath,
|
||||
operationHandlers: path.join(__dirname),
|
||||
fileUploader: { dest: config.FILE_UPLOAD_PATH },
|
||||
}).install(this.app)
|
||||
.catch(e => console.log(e))
|
||||
.then(() => {
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
this.app.use((err, req, res, next) => {
|
||||
// format errors
|
||||
res.status(err.status || 500).json({
|
||||
message: err.message || err,
|
||||
errors: err.errors || '',
|
||||
});
|
||||
} catch (error) {
|
||||
reject(error);
|
||||
}
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
http.createServer(this.app).listen(this.port);
|
||||
console.log(`Listening on port ${this.port}`);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
async close() {
|
||||
if (this.server !== undefined) {
|
||||
await this.server.close();
|
||||
|
||||
Reference in New Issue
Block a user