v8 (v7 Rails v1 Django)
Getting Started
Reference Guide
Extend a route
⚠️ This page is relevant only if you installed Forest Admin directly on a database (SQL/Mongodb). If you installed in a Rails app, check the "Override a route" page.
Extending a route is a clean way to achieve more by building on top of Forest Admin's existing routes.
To extend a route, simply add your own logic before the
next() statement:SQL
Mongodb
/routes/companies.js
1
const express = require('express');
2
const { PermissionMiddlewareCreator } = require('forest-express-sequelize');
3
4
const router = express.Router();
5
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
6
7
...
8
9
// Create a Action Approval - Check out our documentation for more details: https://docs.forestadmin.com/documentation/reference-guide/routes/default-routes#create-a-record
10
router.post('/companies', permissionMiddlewareCreator.create(), (req, res, next) => {
11
// >> Add your logic here <<
12
next();
13
});
14
15
...
16
17
module.exports = router;
Copied!
/routes/companies.js
1
const express = require('express');
2
const { PermissionMiddlewareCreator } = require('forest-express-mongoose');
3
4
const router = express.Router();
5
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('companies');
6
7
...
8
9
// Create a Action Approval - Check out our documentation for more details: https://docs.forestadmin.com/documentation/reference-guide/routes/default-routes#create-a-record
10
router.post('/companies', permissionMiddlewareCreator.create(), (req, res, next) => {
11
// >> Add your logic here <<
12
next();
13
});
14
15
...
16
17
module.exports = router;
Copied!
Adding logic with an API call
The most simple way to trigger your business app's (or any external app's) logic is with an API call!
In the following example, we override the
CREATE route so that a credit card is created whenever a new customer is created in Forest Admin:
/routes/customers.js
1
...
2
3
// Require superagent once you've installed it (npm install superagent)
4
const superagent = require('superagent');
5
6
...
7
8
router.post('/customers', permissionMiddlewareCreator.create(), (req, res, next) => {
9
// Prepare the API call using the Forest Admin's posted data
10
superagent
11
.post('https://my-company/create-card')
12
// Don't forget to authenticate your request using the relevant authentication method
13
.set('X-API-Key', '**********')
14
.end((err, res) => {
15
// Call next() to execute Forest Admin's default behavior
16
next();
17
});
18
});
19
20
...
21
22
module.exports = router;
Copied!
Adding logic with a message broker
Using a message broker - such as RabbitMQ or Kafka - to broadcast events is current practice.
/routes/orders.js
1
...
2
3
const amqp = require('amqplib/callback_api');
4
5
...
6
7
router.put('/orders/:orderId', permissionMiddlewareCreator.update(), (req, res, next) => {
8
// Prepare your message from Forest Admin's updated data
9
var orderId = req.body.data.id;
10
var orderStatus = req.body.data.attributes.shipping_status;
11
var message = 'Order ' + orderId + ' shipping status is now: ' + orderStatus;
12
var queue = 'orders_sync_queue';
13
14
// Connect to your Rabbitmq remote instance and publish your message
15
amqp.connect('amqp://{your_rabbitmq_host}', function(error0, connection) {
16
if (error0) {
17
throw error0;
18
}
19
connection.createChannel(function(error1, channel) {
20
if (error1) {
21
throw error1;
22
}
23
channel.assertQueue(queue, {
24
durable: false
25
});
26
channel.sendToQueue(queue, Buffer.from(message));
27
});
28
setTimeout(function() {
29
connection.close();
30
}, 500);
31
});
32
33
// Call next() to execute Forest Admin's default behavior
34
next();
35
});
36
37
...
38
39
module.exports = router;
Copied!
Adding logic after Forest Admin's default behavior
At some point, you may want to trigger your remote logic after Forest Admin's logic.
To achieve this, you can manually recreate
next()'s behavior by using the snippets of default routes, then append your own logic.Last modified 1yr ago