https://github.com/deliveroo/jsonrpc-go
A microframework for writing JSON-RPC web applications.
https://github.com/deliveroo/jsonrpc-go
library
Last synced: 6 months ago
JSON representation
A microframework for writing JSON-RPC web applications.
- Host: GitHub
- URL: https://github.com/deliveroo/jsonrpc-go
- Owner: deliveroo
- License: unlicense
- Archived: true
- Created: 2020-04-24T23:35:19.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T19:21:55.000Z (over 3 years ago)
- Last Synced: 2024-06-21T19:03:23.456Z (about 2 years ago)
- Topics: library
- Language: Go
- Homepage:
- Size: 46.9 KB
- Stars: 5
- Watchers: 35
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# jsonrpc-go
[](https://circleci.com/gh/deliveroo/jsonrpc-go/tree/master)
[](https://goreportcard.com/report/github.com/deliveroo/jsonrpc-go)
[](https://godoc.org/github.com/deliveroo/jsonrpc-go)
[](https://pkg.go.dev/github.com/deliveroo/jsonrpc-go)
Package jsonrpc implements a microframework for writing JSON-RPC web
applications.
## Methods
Methods are defined as:
```
func(ctx context.Context, params T) (interface{}, error) // JSON unmarshable params
func(ctx context.Context) (interface{}, error) // no params
```
where `T` can be any time which can be unmarshaled from JSON (structs and
primitives).
If a method returns a value along with a nil error, the value will be rendered
to the client as JSON.
If an error is returned, it will be sanitized and returned to the client as
json. Errors generated by a call to `jsonrpc.Error(name, message, args)` will be
rendered as-is to the client. Any other errors will be obfuscated to the caller
(unless `server.DumpErrors` is enabled).
## Spec
`jsonrpc` loosely follows the [JSON-RPC 2.0
Specification](https://www.jsonrpc.org/specification), with some notable
differences:
* the version parameter is not expected, and will not be returned
* errors include a `Name` string, rather than an integer `Code`
## Example
```go
var logger = log.New(os.Stderr, "server: ", 0)
func main() {
server := jsonrpc.New()
server.Use(LoggingMiddleware(logger))
server.Register(jsonrpc.Methods{
"Hello": hello,
})
http.ListenAndServe(":80", server)
}
type helloParams struct {
Name string `json:"name"`
}
func hello(ctx context.Context, params *helloParams) (interface{}, error) {
return jsonrpc.M{"message": fmt.Sprintf("Hello, %s", params.Name)}, nil
}
func LoggingMiddleware(logger *logger.Logger) Middleware {
return func (next jsonrpc.Next) jsonrpc.Next {
return func(ctx context.Context, params interface{}) (interface{}, error) {
method := jsonrpc.MethodFromContext(ctx)
start := time.Now()
defer func() {
logger.Printf("%s (%v)\n", method, time.Since(start))
}()
return next(ctx, params)
}
}
}
```
Request:
```json
{
"id": 1,
"method": "Hello",
"params": {
"name": "Alice"
}
}
```
Response:
```json
{
"id": 1,
"result": {
"message": "Hello, Alice!"
}
}
```