Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rehacktive/caffeine
A basic REST service for JSON data - enough for prototyping and MVPs!
https://github.com/rehacktive/caffeine
golang json-api nosql rest-api
Last synced: 6 days ago
JSON representation
A basic REST service for JSON data - enough for prototyping and MVPs!
- Host: GitHub
- URL: https://github.com/rehacktive/caffeine
- Owner: rehacktive
- License: gpl-3.0
- Created: 2021-10-23T11:26:02.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-30T16:19:55.000Z (about 2 years ago)
- Last Synced: 2025-01-12T17:06:06.216Z (13 days ago)
- Topics: golang, json-api, nosql, rest-api
- Language: Go
- Homepage:
- Size: 3.13 MB
- Stars: 1,182
- Watchers: 12
- Forks: 35
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome - rehacktive/caffeine - api,nosql,rest-api pushed_at:2022-11 star:1.2k fork:0.0k A basic REST service for JSON data - enough for prototyping and MVPs! (Go)
- awesome-list - rehacktive/caffeine - A basic REST service for JSON data - enough for prototyping and MVPs! (Go)
README
# caffeine - minimum viable backend
A very basic REST service for JSON data - enough for prototyping and MVPs!
**Features**:
- no need to set up a database, all data is managed automagically*
- REST paradigm CRUD for multiple entities/namespaces
- JWT authentication
- realtime notifications (HTTP/SSE)
- schema validation
- autogenerates Swagger/OpenAPI specs
- search using jq like syntax (see https://stedolan.github.io/jq/manual/)
- CORS enabled
- easy to deploy as container
**Currently supports**:
- in memory database (map)
- sqlite
- postgres
- filesystem storage
For a sample Vue app using caffeine see: https://gist.github.com/calogxro/6e601e07c2a937df4418d104fb717570
## How to
Simply start the server with:
```go
go run caffeine.go
```
optional params are:
```
Usage of caffeine:
-AUTH_ENABLED=false: enable JWT auth
-DB_TYPE="memory": db type to use, options: memory | postgres | fs | sqlite
-DB_PATH="./data": path of the file storage root or sqlite database
-IP_PORT=":8000": ip:port to expose
-PG_HOST="0.0.0.0": postgres host (port is 5432)
-PG_PASS="": postgres password
-PG_USER="": postgres user
```
Store a new "user" with an ID and some json data:
```sh
> curl -X POST -d '{"name":"jack","age":25}' http://localhost:8000/ns/users/1
{"name":"jack","age":25}
```
the value will be validated, but it could be anything (in JSON!)
retrieve later with:
```sh
> curl http://localhost:8000/ns/users/1
{"name":"jack","age":25}
```
## All operations
Insert/update
```sh
> curl -X POST -d '{"name":"jack","age":25}' http://localhost:8000/ns/users/1
{"name":"jack","age":25}
```
Delete
```sh
> curl -X DELETE http://localhost:8000/ns/users/1
```
Get by ID
```sh
> curl http://localhost:8000/ns/users/1
{"name":"jack","age":25}
```
Get all values for a namespace
```sh
> curl http://localhost:8000/ns/users | jq
[
{
"key": "2",
"value": {
"age": 25,
"name": "john"
}
},
{
"key": "1",
"value": {
"age": 25,
"name": "jack"
}
}
]
```
Get all namespaces
```sh
> curl http://localhost:8000/ns
["users"]
```
Delete a namespace
```sh
> curl -X DELETE http://localhost:8000/ns/users
{}
```
Search by property (jq syntax)
```sh
> curl http://localhost:8000/search/users?filter="select(.name==\"jack\")" | jq
{
"results": [
{
"key": "1",
"value": {
"age": 25,
"name": "jack"
}
}
]
}
```
## JWT Authentication
There's a first implementation of JWT authentication. See [documentation about JWT](JWT.md)
## Realtime Notifications
Using HTTP Server Sent Events (SSE) you can get notified when data changes, just need to listen from the /broker endpoint:
```sh
curl http://localhost:8000/broker
```
and for every insert or delete an event will be triggered:
```sh
{"event":"ITEM_ADDED","namespace":"test","key":"1","value":{"name":"john"}}
...
{"event":"ITEM_DELETED","namespace":"test","key":"1"}
...
```
## Swagger/OpenAPI specs
After you add some data, you can generate the specs with:
```sh
curl -X GET http://localhost:8000/openapi.json
```
or you can just go to http://localhost:8000/swaggerui/ and use it interactively!
## Schema Validation
You can add a schema for a specific namespace, and only correct JSON data will be accepted
To add a schema for the namespace "user", use the one available in schema_sample/:
```sh
curl --data-binary @./schema_sample/user_schema.json http://localhost:8000/schema/user
```
Now only validated "users" will be accepted (see user.json and invalid_user.json under schema_sample/)
## Run as container
```sh
docker build -t caffeine .
```
and then run it:
```sh
docker run --publish 8000:8000 caffeine
```
## Run with Postgres
First run an instance of Postgres (for example with docker):
```sh
docker run -e POSTGRES_USER=caffeine -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -d postgres:latest
```
Then run caffeine with the right params to connect to the db:
```sh
DB_TYPE=postgres PG_HOST=0.0.0.0 PG_USER=caffeine PG_PASS=mysecretpassword go run caffeine.go
```
(params can be passed as ENV variables or as command-line ones)
A very quick to run both on docker with docker-compose:
```sh
docker-compose up -d
```