v8 (v7 Rails v1 Django)
Getting Started
Reference Guide
Routes
What is a route?
A route is simply the mapping between an API endpoint and the business logic behind this endpoint.
Default routes
Forest Admin comes packaged with a set of existing routes, which execute Forest Admin's default logic. The most common ones are :
Route
Default behavior
router.post('/companies', …Create a company
router.put('/companies/:companyId', …Update a company
router.delete('/companies/:companyId', …Delete a company
router.get('/companies/:companyId', …Get a company
router.get('/companies', …List all companies
router.get('/companies/count', …Count the number of companies
router.get('/companies.csv', …Export all companies
Very often, you’ll need to call business logic from another backend application. This is why in Forest Admin, all your admin backend's routes are extendable.
At installation, they are generated in
/routes.Note that for any collection added after installation, you will have to create a new
your_collection_name.js file in /routes.The generated routes use
next() to call Forest Admin's default behavior. If you need more details on what each default route does, check out this page:
To learn how to extend a route's behavior, read this page:
To learn how to override a route's behavior, read this page:
If you want to trigger logic unrelated to Forest Admin's basic routes (create, update, etc), head over to our Smart actions page.
Last modified 2yr ago
Copy link