node-express-json-rpc2

Route-based JSON-RPC middleware for Express

npm install node-express-json-rpc2
1 downloads in the last day
10 downloads in the last week
22 downloads in the last month

Install

node-express-json-rpc2 is a JSON-RPC version 2 spec-compliant handler middleware for the Express library on node.js. It is designed for use within routes. You can install it via:

npm install node-express-json-rpc2

Setup

To use, simply include node-express-JSON-RPC2 in your configure/use statements before app.router:

var express = require('express'),
    jsonrpc = require('node-express-JSON-RPC2');

app.configure(function(){
    ...
    app.use( express.jsonrpc() );
    ...
    app.use( app.router );
});

Use

Within a route, use res.rpc() to handle a given method. The first argument is the method name and the second argument is the function that will be invoked to handle the request.

The first argument passed to the invocation function is the value of the "params" property from the RPC request. Unless the request is a notification, the second argument will be a function to handle the response. The response function will automatically wrap the data passed to it in the RPC response object containing the request ID and jsonrpc property.

app.post('/path/for/rpc/calls', function(req, res, next){
    // notification (no response expected)
    res.rpc('notification_method', function (params) {
        // do processing here
    });

    // non-notification (response expected)
    res.rpc('method_name', function(params, respond){
        // do processing here

        // if everything is OK return result object:
        respond({ result: resultData });

        // if something is wrong, return an error code:
        respond(jsonrpc.INVALID_PARAMS)
        // OR an extended error object:
        respond({
            error: {
                code: jsonrpc.INVALID_PARAMS,
                message: 'You gave me invalid parameters!',
                data: data
            }
        });
    });
});

Success Responses

To respond successfully, simpy pass in an object with a key of 'result' and whatever value you want to respond with:

respond({ result: [ 'Success!' ] });

And your response will go out as:

{
    "jsonrpc": "2.0",
    "result": [ "Success!" ],
    "id": XXX // id will match the ID of the request
}

Error Responses

The middleware provides standard error codes and messages defined by the JSON-RPC version 2 spec. You can reference error codes by using built-in variable names. For example, you may respond with just the error code:

respond(jsonrpc.INVALID_REQUEST);

and your response will go out as:

{
    "jsonrpc": "2.0",
    "error": {
        "code": -32600,
        "message": "Invalid Request"
    },
    "id": null
}

or with an error object (message and data are optional):

respond({ 
    error: {
        code: jsonrpc.INVALID_REQUEST,
        message: "More informational message",
        data: [ 'Debug info...' ] 
    } 
});

and your response will go out as:

{
    "jsonrpc": "2.0",
    "error": {
        "code": -32600,
        "message": "More informational message",
        "data": [ "Debug info..." ]
    },
    "id": null
}

The error code constants for reference:

Variable Name    Code     Message
------------------------------------------------
PARSE_ERROR      -32700  'Parse error'
INVALID_REQUEST  -32600  'Invalid request'
METHOD_NOT_FOUND -32601  'Method not found'
INVALID_PARAMS   -32602  'Invalid parameters'
INTERNAL_ERROR   -32603  'Internal error'

Note: For strict adherence to the specification, you cannot use bodyParser in conjuction with node-express-JSON-RPC2 because bodyParser will catch invalid JSON and return early, preventing a proper "Parse error" RPC response. If you are not terribly worried about strict compliance, using bodyParser is fine.

npm loves you