Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
express-json-rpc-router
Advanced tools
JSON-RPC official spec.
Extremely fast and simple Node.js JSON-RPCv2 router middleware. Handle incoming request and apply to controller functions. Validation available.
Note As Router require body-parser which must be used before router.
$ npm install express express-json-rpc-router
or
$ yarn add express express-json-rpc-router
const express = require('express')
const jsonRouter = require('express-json-rpc-router')
const app = express()
const controller = {
testMethod({ username }) {
console.log('username: ', username)
return ['example data 1', 'example data 2']
}
}
app.use(express.json())
app.use(jsonRouter({ methods: controller }))
app.listen(3000, () => console.log('Example app listening on port 3000'))
and
curl -X POST \
http://localhost:3000 \
-H 'Content-Type: application/json' \
-d '{
"jsonrpc": "2.0",
"method": "testMethod",
"params": {
"username": "valeron"
},
"id": 1
}'
will return:
{
"jsonrpc": "2.0",
"result": [
"example data 1",
"example data 2"
],
"id": 1
}
const controller = {
// You have access to raw express req/res object as raw.res and raw.req
testMethod({ username }, raw) {
console.log('username: ', username)
return ['example data 1', 'example data 2']
}
}
const beforeController = {
// You have access to raw express req/res object as raw.res and raw.req
testMethod(params, _, raw) {
if (Math.random() >= 0.5) { // Random error
const error = new Error('Something going wrong')
error.data = { hello: 'world' } // its optional
throw error
}
}
}
const afterController = {
testMethod: [
// You have access to result and to raw express req/res object as raw.res and raw.req.
(params, result, raw) => console.log('testMethod executed 1!'), () => console.log('testMethod executed 2!')
]
}
app.use(bodyParser.json())
app.use(jsonRouter({
methods: controller,
beforeMethods: beforeController,
afterMethods: afterController,
onError(err) {
console.log(err) // send report
}
}))
app.listen(3000, () => console.log('Example app listening on port 3000'))
and
curl -X POST \
http://localhost:3000 \
-H 'Content-Type: application/json' \
-d '{
"jsonrpc": "2.0",
"method": "testMethod",
"params": {
"username": "valeron"
},
"id": 1
}'
will return:
{
"jsonrpc": "2.0",
"error": {
"code": -32603,
"message": "Something going wrong",
"data": { "hello": "world" }
},
"id": 1
}
- v1.2.0
* Added raw { req, res } native express object to controller and hooks as last argument.
* Passed next arguments: `params, null, raw` to beforeController actions and `params, result, raw` to afterController
* Passed additional second argument `params, raw` to controller actions
- v1.3.0
* Added optional err.data payload to comply with JSON RPC specification: "5.1 Error object".
The express-json-rpc-router
function takes an optional options
object that may contain any of the following keys:
type: Object<function(params)>
You can pass the object of your methods that will be called when a match is made via JSON-RPC method
field.
type: Object<function(params)|Array<function(params)>>
You can provide function or array of functions, which will be called before main method with same name are called. This is the best place for validation. beforeMethods names should be the same as methods names. Request params will be passed as first argument.
type: Object<function(params, execResult)|Array<function(params, execResult)>>
You can provide function or array of functions, which will be called after main method with same name are called. This is the best place to write logs. afterMethods names should be the same as methods names. Method execution result will be passed as second argument. Request params will be passed as first argument.
type: function(err, params)
callback(err, params) {} Optionally you can pass onError callback which will be called when json-rpc middleware error occurred.
FAQs
Json-rpc middleware router for express
The npm package express-json-rpc-router receives a total of 49 weekly downloads. As such, express-json-rpc-router popularity was classified as not popular.
We found that express-json-rpc-router 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
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.