Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osaminGo/jsonrpc
The jsonrpc package helps implement of JSON-RPC 2.0
https://github.com/osaminGo/jsonrpc
api go json json-rpc rpc rpc-api
Last synced: 20 days ago
JSON representation
The jsonrpc package helps implement of JSON-RPC 2.0
- Host: GitHub
- URL: https://github.com/osaminGo/jsonrpc
- Owner: osamingo
- License: mit
- Created: 2016-10-28T13:36:59.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T16:03:25.000Z (over 1 year ago)
- Last Synced: 2024-07-31T01:24:36.094Z (4 months ago)
- Topics: api, go, json, json-rpc, rpc, rpc-api
- Language: Go
- Homepage:
- Size: 99.6 KB
- Stars: 189
- Watchers: 5
- Forks: 23
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# jsonrpc
[](https://github.com/osamingo/jsonrpc/actions?query=workflow%3ACI+branch%3Amaster)
[](https://codecov.io/gh/osamingo/jsonrpc)
[](https://goreportcard.com/report/osamingo/jsonrpc)
[](https://codebeat.co/projects/github-com-osamingo-jsonrpc)
[](https://codeclimate.com/github/osamingo/jsonrpc/maintainability)
[](https://godoc.org/github.com/osamingo/jsonrpc/v2)
[](https://raw.githubusercontent.com/osamingo/jsonrpc/master/LICENSE)
## About
- Simple, Poetic, Pithy.
- Compliance with [JSON-RPC 2.0](http://www.jsonrpc.org/specification).
## Install
```
$ go get github.com/osamingo/jsonrpc/v2@latest
```
## Usage
```go
package main
import (
"context"
"log"
"net/http"
"github.com/goccy/go-json"
"github.com/osamingo/jsonrpc/v2"
)
type (
EchoHandler struct{}
EchoParams struct {
Name string `json:"name"`
}
EchoResult struct {
Message string `json:"message"`
}
PositionalHandler struct{}
PositionalParams []int
PositionalResult struct {
Message []int `json:"message"`
}
)
func (h EchoHandler) ServeJSONRPC(c context.Context, params *json.RawMessage) (any, *jsonrpc.Error) {
var p EchoParams
if err := jsonrpc.Unmarshal(params, &p); err != nil {
return nil, err
}
return EchoResult{
Message: "Hello, " + p.Name,
}, nil
}
func (h PositionalHandler) ServeJSONRPC(c context.Context, params *json.RawMessage) (any, **jsonrpc.Error) {
var p PositionalParams
if err := jsonrpc.Unmarshal(params, &p); err != nil {
return nil, err
}
return PositionalResult{
Message: p,
}, nil
}
func main() {
mr := jsonrpc.NewMethodRepository()
if err := mr.RegisterMethod("Main.Echo", EchoHandler{}, EchoParams{}, EchoResult{}); err != nil {
log.Fatalln(err)
}
if err := mr.RegisterMethod("Main.Positional", PositionalHandler{}, PositionalParams{}, PositionalResult{}); err != nil {
log.Fatalln(err)
}
http.Handle("/jrpc", mr)
http.HandleFunc("/jrpc/debug", mr.ServeDebug)
if err := http.ListenAndServe(":8080", http.DefaultServeMux); err != nil {
log.Fatalln(err)
}
}
```
#### Advanced
```go
package main
import (
"log"
"net/http"
"github.com/osamingo/jsonrpc/v2"
)
type (
HandleParamsResulter interface {
jsonrpc.Handler
Name() string
Params() any
Result() any
}
Servicer interface {
MethodName(HandleParamsResulter) string
Handlers() []HandleParamsResulter
}
UserService struct {
SignUpHandler HandleParamsResulter
SignInHandler HandleParamsResulter
}
)
func (us *UserService) MethodName(h HandleParamsResulter) string {
return "UserService." + h.Name()
}
func (us *UserService) Handlers() []HandleParamsResulter {
return []HandleParamsResulter{us.SignUpHandler, us.SignInHandler}
}
func NewUserService() *UserService {
return &UserService{
// Initialize handlers
}
}
func main() {
mr := jsonrpc.NewMethodRepository()
for _, s := range []Servicer{NewUserService()} {
for _, h := range s.Handlers() {
mr.RegisterMethod(s.MethodName(h), h, h.Params(), h.Result())
}
}
http.Handle("/jrpc", mr)
http.HandleFunc("/jrpc/debug", mr.ServeDebug)
if err := http.ListenAndServe(":8080", http.DefaultServeMux); err != nil {
log.Fatalln(err)
}
}
```
### Result
#### Invoke the Echo method
```
POST /jrpc HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 82
Content-Type: application/json
Host: localhost:8080
User-Agent: HTTPie/0.9.6
{
"jsonrpc": "2.0",
"method": "Main.Echo",
"params": {
"name": "John Doe"
},
"id": "243a718a-2ebb-4e32-8cc8-210c39e8a14b"
}
HTTP/1.1 200 OK
Content-Length: 68
Content-Type: application/json
Date: Mon, 28 Nov 2016 13:48:13 GMT
{
"jsonrpc": "2.0",
"result": {
"message": "Hello, John Doe"
},
"id": "243a718a-2ebb-4e32-8cc8-210c39e8a14b"
}
```
#### Invoke the Positional method
```
POST /jrpc HTTP/1.1
Accept: */*
Content-Length: 133
Content-Type: application/json
Host: localhost:8080
User-Agent: curl/7.61.1
{
"jsonrpc": "2.0",
"method": "Main.Positional",
"params": [3,1,1,3,5,3],
"id": "243a718a-2ebb-4e32-8cc8-210c39e8a14b"
}
HTTP/1.1 200 OK
Content-Length: 97
Content-Type: application/json
Date: Mon, 05 Nov 2018 11:23:35 GMT
{
"jsonrpc": "2.0",
"result": {
"message": [3,1,1,3,5,3]
},
"id": "243a718a-2ebb-4e32-8cc8-210c39e8a14b"
}
```
#### Access to debug handler
```
GET /jrpc/debug HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: localhost:8080
User-Agent: HTTPie/0.9.6
HTTP/1.1 200 OK
Content-Length: 408
Content-Type: application/json
Date: Mon, 28 Nov 2016 13:56:24 GMT
[
{
"handler": "EchoHandler",
"name": "Main.Echo",
"params": {
"$ref": "#/definitions/EchoParams",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"EchoParams": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
},
"result": {
"$ref": "#/definitions/EchoResult",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"EchoResult": {
"additionalProperties": false,
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
}
}
}
}
]
```
## License
Released under the [MIT License](https://github.com/osamingo/jsonrpc/blob/master/LICENSE).