Module: src/api/v1

API Router Module (V1) Integrates with various models through a common Interface (.get(), .post(), .put(), .delete())
Source:

Methods

(inner) handleDelete(req, res, next)

Deletes a single record from a given model.
Parameters:
Name Type Description
req object Express Request Object (required params: model, id)
res object Express Response Object
next function Express middleware next()
Source:
Example
router.delete('/api/v1/:model/:id', handleDelete);

(inner) handleGetAll(req, res, next)

Fetches all records from a given model.
Parameters:
Name Type Description
req object Express Request Object (required params: model)
res object Express Response Object
next function Express middleware next()
Source:
Example
router.get('/api/v1/:model', handleGetAll);

(inner) handleGetOne(req, res, next)

Fetches a single record from a given model.
Parameters:
Name Type Description
req object Express Request Object (required params: model, id)
res object Express Response Object
next function Express middleware next()
Source:
Example
router.get('/api/v1/:model/:id', handleGetOne);

(inner) handlePost(req, res, next)

Creates a single record in a given model.
Parameters:
Name Type Description
req object Express Request Object (required params: req.model)
res object Express Response Object
next function Express middleware next()
Source:
Example
router.post('/api/v1/:model', handlePost);

(inner) handlePut(req, res, next)

Updates a single record in a given model.
Parameters:
Name Type Description
req object Express Request Object (required params: model, id)
res object Express Response Object
next function Express middleware next()
Source:
Example
router.put('/api/v1/:model/:id', handlePut);