Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/erisa/redis-exposer

Serve read-only Redis data over a HTTP API with auth
https://github.com/erisa/redis-exposer

api express redis

Last synced: 7 days ago
JSON representation

Serve read-only Redis data over a HTTP API with auth

Host: GitHub
URL: https://github.com/erisa/redis-exposer
Owner: Erisa
License: unlicense
Created: 2022-03-15T20:47:49.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-09-21T07:20:00.000Z (about 2 months ago)
Last Synced: 2024-11-02T14:35:28.310Z (14 days ago)
Topics: api, express, redis
Language: JavaScript
Homepage:
Size: 192 KB
Stars: 10
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Redis data exposer

This was created for [Cliptok](https://github.com/Erisa/Cliptok) and not intended for use outside of it.
Use at your own peril.

This application will serve an API that will return read-only data from your configured Redis server.

## Disclaimer

The code here is not the best code it could have been. I am not overly proficient with JavaScript and this code was written to serve a single purpose. Please be gentle.

If you use this for some reason and have an issue, please report it.

## Setup

Environment variables (none are required):
- `PORT`: The port to listen on. Default is `3000`.
- `REDIS_URL`: URL pointing to the redis server to connect to. Default is localhost.
- `SECRET`: The secret to pass for authorization. Default is `superscarysecret`.

Run Docker image `ghcr.io/erisa/redis-exposer` or clone, `yarn` and `yarn start`.

## Usage

Required: `Authorization` header or `secret` query parameter with the correct value.

### `GET /:key`

If `key` held `value`, you would get something like:
```json
{
"code": 200,
"data": "value"
}
```

If the value is JSON, it will be parsed.
For example if `key` held `{"thing": "otherthing"}` you would get:
```json
{
"code": 200,
"data": {
"thing": "otherthing"
}
}
```

Big numbers will be converted to strings. Or maybe it was all numbers, I don't remember.

If the key is a list, it will be returned as such:
```json
{
"code": 200,
"data": [
"thing",
"otherthing"
]
}
```

You can also put JSON inside a list item, if you want.

If the value is a hash, it will return all items, same as JSON:
```json
{
"code": 200,
"data": {
"thing": "otherthing"
}
}
```

### `GET /:key/:value`

If the key is not a hash or a set, you get yelled at:

```json
{
"code": 400,
"message": "Bad request, key is not a hash or set and cannot be accessed like one. Try /:key."
}
```

If the value does not exist, you also get yelled at:
```json
{
"code": "404",
"message": "Key/value pair does not exist or is null."
}
```

But if a hash exists, you get data:
```json
{
"code": 200,
"data": "thing in a hash"
}
```

If the key is a set and value does not exist, you get a slightly different error:
```json
{
"code": 404,
"memberExists": false,
"message": "Member does not exist in the set."
}
```

If the key is a set and the value exists, you get confirmation and the value back again:
```json
{
"code": 200,
"memberExists": true,
"data": "thing1"
}
```

## The end

That's it. There's nothing more to tell.