
Product
Socket Now Supports pylock.toml Files
Socket now supports pylock.toml, enabling secure, reproducible Python builds with advanced scanning and full alignment with PEP 751's new standard.
A lightweight configuration framework for express.js that aims to simplify creating API endpoints with a distributed back-end. Reducto acts as an aggregator that allows you to declare routes and services in a straighforward, easy-to-scan way.
Reducto only provides configuration for express, so you will need to install express along with reducto:
npm install reducto express --save
You must provide both a routes and services config to reducto along with your express app, and reducto then parses your configuration and builds your express routes with all the configured middleware.
const express = require('express');
const reducto = require('reducto');
const app = express();
const routes = require('your_route_config.json');
const services = require('your_services_config.json');
reducto(app, routes, services);
app.listen(3000);
The route configuration file lets you declare what endpoints you expose and what those endpoints do. Routes can be configured to use middleware, views, fixtures and service calls. Middlware should be added in the order you want them to run.
{
"/my/route/:id": {
"GET": [
{ "type": "middleware", "path": "./lib/middleware.js#myFuncName" },
{ "type": "service", "name": "GET:myEndpoint" },
{ "type": "fixture", "data": {
"title": "My awesome page title"
}},
{ "type": "view", "name": "my-view" }
],
"POST": [
{ "type": "service", "name": "POST:myEndpoint" },
{ "type": "transform", "path": "./lib/my-post-transform.js" }
]
}
}
Each route is defined by its URI pattern. This can be any legal express route pattern. Next you define the HTTP methods per route. Each method has its own list of middleware configurations. These configurations are used to construct the middleware that is added to your express route.
The path to the middleware file(with optional function name as file.js#myFuncName), or the name of any 3rd-party express middleware.
The name of service endpoint from your services config file.
An optional key where all returned data will be stored in the response.
An optional schema to map returned data to.
An optional context for value replacement.
A list of service middleware configurations that will be called as an asynchronous batch.
The data key to pull list from.
The configuration for the service to call.
The object path to search for list to filter.
The key to filter on.
The value to filter by.
Any valid configuration for service.dataSchema
An optional key to store the mapped data in res.locals
A JSON object containing static data. This data is added to the cumulative res.locals
object.
The name of a view to render with res.render
. You must provide express with a rendering engine for this to work. See examples.
Services, or rather, service calls, represent any callable HTTP endpoint.
NOTE: headers may contain the string FROM_REQUEST
in order to pass header values from the request to the underlying service call.
{
"myEndpoint": {
"GET": {
"uri": "http://myws.com/api/someresource/{id}",
"headers": {
"Accepts": "application/xml",
"Authorization": "FROM_REQUEST"
}
},
"POST": {
"uri": "http://myws.com/api/someresource"
}
}
}
The route config is using the express routing mechanism for parameters: /my/route/:id
. This data can then be used in our service calls by
placing a corresponding URI token in the service definition: http://myws.com/api/someresource/{id}
where {id}
will map to :id
. Query params, routes params, request body, and data returned from previous service calls can all be used to pass data to the service call.
Service calls use the request module to handle HTTP, so any valid configuration for request applies here.
An optional JSON schema that describes the request body to send to the service call. Paths are specified according to pathval.
{
"bodySchema": {
"foo": "data.content.foo",
"bar": "data.content.bars[0]"
}
}
Navigate to the root directory and run npm start
. This will start the example app at
http://localhost:3000
. You can view the example page by pointing your browser to http://localhost:3000/local/:zipcode
where :zipcode
is any valid zip. All example code can be found in the /examples
directory.
FAQs
Configuration-based routing and service definitions for express.js.
The npm package reducto receives a total of 0 weekly downloads. As such, reducto popularity was classified as not popular.
We found that reducto demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports pylock.toml, enabling secure, reproducible Python builds with advanced scanning and full alignment with PEP 751's new standard.
Security News
Research
Socket uncovered two npm packages that register hidden HTTP endpoints to delete all files on command.
Research
Security News
Malicious Ruby gems typosquat Fastlane plugins to steal Telegram bot tokens, messages, and files, exploiting demand after Vietnam’s Telegram ban.