Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jirenius/go-res
RES Service protocol library for Go
https://github.com/jirenius/go-res
go golang golang-package microservice nats-server real-time realtime resgate rest-api
Last synced: 14 days ago
JSON representation
RES Service protocol library for Go
- Host: GitHub
- URL: https://github.com/jirenius/go-res
- Owner: jirenius
- License: mit
- Created: 2018-07-15T09:10:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T18:42:04.000Z (4 months ago)
- Last Synced: 2024-07-31T20:52:18.735Z (3 months ago)
- Topics: go, golang, golang-package, microservice, nats-server, real-time, realtime, resgate, rest-api
- Language: Go
- Homepage:
- Size: 3.25 MB
- Stars: 62
- Watchers: 5
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - go-res - Package for building REST/real-time services where clients are synchronized seamlessly, using NATS and Resgate. (Messaging / Search and Analytic Databases)
- zero-alloc-awesome-go - go-res - Package for building REST/real-time services where clients are synchronized seamlessly, using NATS and Resgate. (Messaging / Search and Analytic Databases)
- awesome-go-extra - go-res - 07-15T09:10:11Z|2022-01-17T10:23:05Z| (Messaging / Advanced Console UIs)
README
RES Service for Go
Synchronize Your Clients
---
[Go](http://golang.org) package used to create REST, real time, and RPC APIs, where all your reactive web clients are synchronized seamlessly through [Resgate](https://github.com/resgateio/resgate).
Visit [Resgate.io](https://resgate.io) for more information.
## Installation
```bash
go get github.com/jirenius/go-res
```
## As easy as
```go
package main
import res "github.com/jirenius/go-res"
func main() {
s := res.NewService("example")
s.Handle("model",
res.Access(res.AccessGranted),
res.GetModel(func(r res.ModelRequest) {
r.Model(struct {
Message string `json:"message"`
}{"Hello, World!"})
}),
)
s.ListenAndServe("nats://localhost:4222")
}
```
> **Prerequisite**
>
> [Install](https://resgate.io/docs/get-started/installation/) *NATS Server* and *Resgate*. Can be done with 3 docker commands:
> ```text
> docker network create res
> docker run -d --name nats -p 4222:4222 --net res nats
> docker run --name resgate -p 8080:8080 --net res resgateio/resgate --nats nats://nats:4222
> ```
## Examples
| Example | Description
| --- | ---
| [Hello World](examples/01-hello-world/) | Smallest of services serving a static message.
| [Edit Text](examples/02-edit-text/) | Single text field that is updated in real time.
| [Book Collection](examples/03-book-collection/) | List of book titles & authors that can be edited by many.
| [Book Collection Store](examples/04-book-collection-store/) | Book Collection example persisting changes using BadgerBD store.
| [Search Query](examples/05-search-query/) | Make live queries against a large customer database.
> **Note**
>
> Above examples are complete with both service and client.
## Usage
#### Create a new service
```go
s := res.NewService("myservice")
```
#### Add handlers for a model resource
```go
mymodel := map[string]interface{}{"name": "foo", "value": 42}
s.Handle("mymodel",
res.Access(res.AccessGranted),
res.GetModel(func(r res.ModelRequest) {
r.Model(mymodel)
}),
)
```
#### Add handlers for a collection resource
```go
mycollection := []string{"first", "second", "third"}
s.Handle("mycollection",
res.Access(res.AccessGranted),
res.GetCollection(func(r res.CollectionRequest) {
r.Collection(mycollection)
}),
)
```
#### Add handlers for parameterized resources
```go
s.Handle("article.$id",
res.Access(res.AccessGranted),
res.GetModel(func(r res.ModelRequest) {
article := getArticle(r.PathParam("id"))
if article == nil {
r.NotFound()
} else {
r.Model(article)
}
}),
)
```
#### Add handlers for method calls
```go
s.Handle("math",
res.Access(res.AccessGranted),
res.Call("double", func(r res.CallRequest) {
var p struct {
Value int `json:"value"`
}
r.ParseParams(&p)
r.OK(p.Value * 2)
}),
)
```
#### Send change event on model update
A change event will update the model on all subscribing clients.
```go
s.With("myservice.mymodel", func(r res.Resource) {
mymodel["name"] = "bar"
r.ChangeEvent(map[string]interface{}{"name": "bar"})
})
```
#### Send add event on collection update:
An add event will update the collection on all subscribing clients.
```go
s.With("myservice.mycollection", func(r res.Resource) {
mycollection = append(mycollection, "fourth")
r.AddEvent("fourth", len(mycollection)-1)
})
```
#### Add handlers for authentication
```go
s.Handle("myauth",
res.Auth("login", func(r res.AuthRequest) {
var p struct {
Password string `json:"password"`
}
r.ParseParams(&p)
if p.Password != "mysecret" {
r.InvalidParams("Wrong password")
} else {
r.TokenEvent(map[string]string{"user": "admin"})
r.OK(nil)
}
}),
)
```
#### Add handlers for access control
```go
s.Handle("mymodel",
res.Access(func(r res.AccessRequest) {
var t struct {
User string `json:"user"`
}
r.ParseToken(&t)
if t.User == "admin" {
r.AccessGranted()
} else {
r.AccessDenied()
}
}),
res.GetModel(func(r res.ModelRequest) {
r.Model(mymodel)
}),
)
```
#### Using routes
```go
s.Route("v2", func(m *res.Mux) {
m.Handle("mymodel",
/* ... */
)
})
```
#### Start service
```go
s.ListenAndServe("nats://localhost:4222")
```
## Testing [![Reference][godev]](https://pkg.go.dev/github.com/jirenius/go-res/restest)
The [restest](restest/) subpackage is used for testing services and validate responses.
## Inter-service communication [![Reference][godev]](https://pkg.go.dev/github.com/jirenius/go-res/resprot)
The [resprot](resprot/) subpackage provides low level structs and methods for communicating with other services over NATS server.
## Storage [![Reference][godev]](https://pkg.go.dev/github.com/jirenius/go-res/store)
The [store](store/) subpackage contains handlers and interfaces for working with database storage.
| Name | Description | Documentation
| --- | --- | ---
| [mockstore](store/mockstore/) | Mock store implementation for testing | [![Reference][godev]](https://pkg.go.dev/github.com/jirenius/go-res/store/mockstore)
| [badgerstore](store/badgerstore/) | BadgerDB store implementation | [![Reference][godev]](https://pkg.go.dev/github.com/jirenius/go-res/store/badgerstore)
## Credits
Inspiration on the go-res API has been taken from [github.com/go-chi/chi](https://github.com/go-chi/chi), a great package when writing ordinary HTTP services, and will continue to do so when it is time to implement Middleware, sub-handlers, and mounting.
## Contributing
The go-res package is still under development, but the API is mostly settled. Any feedback on the package API or its implementation is highly appreciated!
Once the API is fully settled, the package will be moved to the [resgateio](https://github.com/resgateio/) GitHub organization.
If you find any issues, feel free to [report them](https://github.com/jirenius/go-res/issues/new) as an issue.
[godev]: https://img.shields.io/static/v1?label=reference&message=go.dev&color=5673ae "Reference"