README
¶
Book Collection Store Example
Tags: Models, Collections, Linked resources, Call methods, Resource parameters, Store
Description
This is the Book Collection example where all changes are persisted using a badgerDB store.
Prerequisite
Install and run
git clone https://github.com/jirenius/go-res
cd go-res/examples/04-book-collection-store
go run .
Open the client
http://localhost:8084
Things to try out
BadgerDB persistence
Run the client and make changes to the list of books. Restart the service and observe that all changes are persisted.
Title sorting
The store sorts books by title. Change the title of one of the books. Observe how the list remains sorted by title.
API
| Request | Resource | Description |
|---|---|---|
| get | library.books |
Collection of book model references. |
| call | library.books.new |
Creates a new book. |
| get | library.book.<BOOK_ID> |
Models representing books. |
| call | library.book.<BOOK_ID>.set |
Sets the books' title and author properties. |
| call | library.book.<BOOK_ID>.delete |
Deletes a book. |
REST API
Resources can be retrieved using ordinary HTTP GET requests, and methods can be called using HTTP POST requests.
Get book collection
GET http://localhost:8080/api/library/books
Get book
GET http://localhost:8080/api/library/book/<BOOK_ID>
Update book properties
POST http://localhost:8080/api/library/book/<BOOK_ID>/set
Body
{ "title": "Animal Farming" }
Add new book
POST http://localhost:8080/api/library/books/new
Body
{ "title": "Dracula", "author": "Bram Stoker" }
Delete book
POST http://localhost:8080/api/library/books/delete
Body
{ "id": <BOOK_ID> }
Documentation
¶
Overview ¶
This is the Book Collection example where all changes are persisted using a badgerDB store.
* It exposes a collection, `library.books`, containing book model references. * It exposes book models, `library.book.<BOOK_ID>`, of each book. * The books are persisted in a badgerDB store under `./db`. * The store.Handler handles get requests by loading resources from the store. * The store.QueryHandler handles get requests by getting a list of stored books. * Changed made to the store bubbles up as events. * It serves a web client at http://localhost:8084
Source Files