3.0.0 • Published 4 years ago
express-base-api v3.0.0
Express base API
- Secure config
- Prevent XSS attacks
- Prevent DDos attacks
- Use compression to responses
- Removes powerby http head
- Enable CORS
- Body parser:
- urlencoded supported
- json responses
Examples
Controlled by steps
- Enable or not body parser.
- Enable secure configs: enable or not cors, enable or not prevent xss attacks...
/** @var object aplica configuración sobre express */
const PoweredExpress = require('./src/app');
/** @var object aplicación express */
const Express = require('express');
/** @var object aplicación express enrriquecida con la configuración de PoweredExpress */
var App = new PoweredExpress(Express())
.enableBodyParser()
.enableConfig()
.getApp();
Quickly instance
- Apply default config: secure is enabled but cors is enable too, bodyParser is supported fully...
var App = new PoweredExpress(Express(), true).getApp()
Complete example
/** @var object aplica configuración sobre express */
const PoweredExpress = require('express-base-api');
/** @var object aplicación express */
const Express = require('express');
/** @var object aplicación express enrriquecida con la configuración de PoweredExpress */
var App = new PoweredExpress(Express())
.enableBodyParser()
.enableSecureApp()
.getApp();
// define api routes
App.get('/', async (req, res) => {
res.json('api responses')
});
// http default methods
App.use((req, res, next) => res.status(404).send({ message: 'Route' + req.url + ' Not found.' }) );
// 404 http error
App.use((err, req, res, next) => res.status(500).send({ error: err }));
// 500 - Any server error
App.listen(3000, () => console.log('Example app listening on port!'));