express-mate
Helper library that makes your life a little easier when working with Express REST APIs
Setup
The express-mate library is designed to be 'plug-and-play'. It exposes a bunch of helper functions and classes that can be used in your project however you like.
Error Handler
The custom express-mate error handler catches ApiObjects thrown in next(err)
and handles them appropriately by responding to the client.
; express.useerrorHandler;
Handlers
Handlers are express request handlers that handle the express-mate repsonse objects. createHandler
creates a handler function that can be added to an express router.
; ; // Add the handler to the express routerrouter.get'/hello-world', helloWorld;
Hooks
Hooks are functions that 'hook' into a express router with a endpoints all starting at a specified endpoint.
; ; ; // Add the hook to the express routerrouter.use'/', helloWorld;
Helpers
checkReq
The checkReq
function checks the express request handlers req
object for variables that may have been added to it and want to be accessed safely.
; ;
Response Objects
All response objects follow the JSend guidelines.
- ApiSuccess
; router.post'/hello-world',; /** * Response: * * HTTP 200 * { * "status": "success", * "data": "Hello World!" * } */
- ApiError
; router.post'/hello-world',; /** * Response: * * HTTP 500 * { * "status": "error", * "message": "Hello World!" * } */
- ApiFail
- ApiForbidden
- ApiUnauthorized
- ApiNotFound