express-boilerplate-api

Description

express-boilerplate-api is a quick way to get started on a api project.

Get started

npx express-boilerplate-api express-api

This will create a project folder called express-api.

Code structur is:

• express-api
  • controllers
  • routes
  • mysql.js
  • server.js
  • .env

To start in developer mode type:

npm run dev

This is based on nodemon and will reload when a file is saved

Routes

A routes file shout look like this:

const express = require('express');
const example = require('../controllers/example');

const router = express.Router();

router.post('/post', (req, res) => {
	example.post(req, res);
});

router.get('/get', (req, res) => {
    example.get(req, res);
});

module.exports = router;

Controllers

A components file shout look like this:

const db = require('../mysql');

const Example = {
    post: function(req, res){
		let body = req.body;
        try {
            await db.query('INSERT INTO test(name, email) VALUES (?, ?)', [
                body.name,
                body.email
            ]);
            res.status(201).send({Message: 'Successfully created new user'});
        } catch (e) {
            res.status(500).send({Error: 'A error occurred'});
        }
    },
    get: function(req, res){
        try {
            let [rows, fields] = await db.query('SELECT * FROM test');
            res.status(200).send(rows);
        } catch (e) {
            res.status(500).send({Error: 'A error occurred'});
        }
    }
}

module.exports = Example;

Server.js

Adding a routes file to server.js

const express = require('express');
const dotenv = require('dotenv');
const cors = require('cors');

dotenv.config();
const app = express();
const port = process.env.PORT;

app.use(express.json());
app.use(express.urlencoded({ extended: false }));

app.use(cors());

const test = require('./routes/example.routes');

app.get('/', (req, res) => {
    res.send({Obi_Wan: "Hello there", Grievous: "General Kenobi"});
});

app.use('/example', test);

app.listen(port, () => {
    console.log('port: 3000');
});