JSON RPC 2.0 Client/Server Package

Simple Golang implementation of JSON-RPC 2.0 Specification

Limitations:

• "Notification" request processed as ordinary request
• Batch requests not implemented now, see ToDo

Install:

go get github.com/mcmx73/rpc

Simple JSON-RPC Server example:

package main

import (
	"fmt"
	"github.com/mcmx73/rpc"
	"github.com/valyala/fasthttp"
)

const (
	LISTEN_ADDRESS = ":8085"
)

func main() {
	apiRouter := rpc.NewRpcRouter()
	apiRouter.RegisterProcessor("users", func(ctx *rpc.ApiContext, request *rpc.ApiRequest, response *rpc.ApiResponse) (err error) {
		// ... do logic ...
		userList := []string{"Alice", "Bob", "John", "Zorro"}
		response.SetResult(userList)
		return nil
	})
	fmt.Println("Listen address: [" , LISTEN_ADDRESS,"]")
	err := fasthttp.ListenAndServe(LISTEN_ADDRESS, apiRouter.Handle)
	if err != nil {
		fmt.Println("Can not serve JSON RPC:", err)
	}
}

Example request:

curl -X POST \
     -H 'Content-Type: application/json' \
     -d '{"jsonrpc":"2.0","id":11,"method":"users","params":{}}' \
     http://localhost:8085

Request result:

{"id":11,"jsonrpc":"2.0","result":["Alice","Bob","John","Zorro"]}

You can parse request params direct to golang struct:

type MyRequestParams struct {
	UserId int             `json:"user_id"`
	Flags  map[string]bool `json:"flags"`
}

func ProcessComplexRequest(ctx *rpc.ApiContext, request *rpc.ApiRequest, response *rpc.ApiResponse) (err error) {
	myRequestParams := &MyRequestParams{}
	err = request.ParseParamsToObject(myRequestParams)
	if err != nil {
		response.SetError(rpc.ERROR_CODE_INVALID_REQUEST, rpc.ERROR_MESSAGE_INVALID_REQUEST)
		return err
	}
	// ... do logic ...
	response.SetResult(struct {
		Success bool `json:"success"`
	}{Success: true})
	return nil
}

TODO

• Implement Batch requests
• Add tests
• Implement RPC Request Signing
• Add more examples