Router Configurations

As mentioned previously, the router is highly configurable to each project needs and desires. The point of the router is to enforce predictable thus making the API more extensible. Below is a table of all the configuration options available:

Example

Don't like reading documentation? Then look at our examples which can run locally!

Configuration Options

option	type	required	description
afterAll	func	no	will call this function after EVERY request to the API
autoValidate	bool	no; requires schemaPath	will automatically validate request against openapi.yml
basePath	str	yes	the base path of the API Gateway instance this is running on
beforeAll	func	no	will call this function before EVERY request to the API
globalLogger	bool	no	will assign the ALC logger to the global variable globalLogger
handlerPath	str	yes, if routingMode == 'directory'	file path pointing to the directory where the endpoints are
handlerPattern	str	yes, if routingMode == 'pattern'	glob pattern to be able to find the endpoint files
handlerList	object	yes, if routingMode == 'list'	object key, value pair to be able to map routes to files
loggerCallback	func	no	will call this function on every call to global.logger
onError	func	no	will call this function on every unhandled error; not including validation errors
routingMode	enum	yes; directory or pattern or list	determines how to route requests to the right files; 3 modes
schemaPath	str	yes, if autoValidate	file path pointing to the location of the openapi.yml file
withAuth	func	no	will call this function when requirements have requiredAuth set to true

Example: Router Config with Directory Routing

const {Router} = require('@syngenta-digital/alc').apigateway;
const MiddlewareUtils = require('api/logic/utils/middleware');
const Authenticator = require('api/logic/authenticator');

exports.route = async (event) => {
    const router = new Router({
        basePath: 'api',
        routingMode: 'directory',
        handlerPath: 'api/handler',
        schemaPath: 'api/openapi.yml',
        autoValidate: true,
        globalLogger: true,
        beforeAll: MiddlewareUtils.beforeAll,
        afterAll: MiddlewareUtils.afterAll,
        onError: MiddlewareUtils.onError,
        withAuth: Authenticator.authenticate,
        loggerCallback: MiddlewareUtils.loggerCallback,
    });
    return router.route(event);
};

Example: Router Config with Pattern Routing

const {Router} = require('@syngenta-digital/alc').apigateway;
const MiddlewareUtils = require('api/logic/utils/middleware');
const Authenticator = require('api/logic/authenticator');

exports.route = async (event) => {
    const router = new Router({
        basePath: 'api',
        routingMode: 'pattern',
        handlerPattern: 'api/**/*.controller.js'
        schemaPath: 'api/openapi.yml',
        autoValidate: true,
        globalLogger: true,
        beforeAll: MiddlewareUtils.beforeAll,
        afterAll: MiddlewareUtils.afterAll,
        onError: MiddlewareUtils.onError,
        withAuth: Authenticator.authenticate,
        loggerCallback: MiddlewareUtils.loggerCallback,
    });
    return router.route(event);
};

Example: Router Config with List Routing

const {Router} = require('@syngenta-digital/alc').apigateway;
const MiddlewareUtils = require('api/logic/utils/middleware');
const Authenticator = require('api/logic/authenticator');

const routes = {
    'GET::grower': 'api/routes/grower.js',
    'POST::farm': 'api/routes/farm.js',
    'PUT:farm/{farmId}/field/{fieldId}': 'api/routes/farm-field.js'
}

exports.route = async (event) => {
    const router = new Router({
        basePath: 'api',
        routingMode: 'list',
        handlerList: routes,
        schemaPath: 'api/openapi.yml',
        autoValidate: true,
        globalLogger: true,
        beforeAll: MiddlewareUtils.beforeAll,
        afterAll: MiddlewareUtils.afterAll,
        onError: MiddlewareUtils.onError,
        withAuth: Authenticator.authenticate,
        loggerCallback: MiddlewareUtils.loggerCallback
    });
    return router.route(event);
};