Redis data exposer

This was created for 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:

{
    "code": 200,
    "data": "value"
}

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

{
    "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:

{
    "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:

{
    "code": 200,
    "data": {
        "thing": "otherthing"
    }
}

`GET /:key/:value`

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

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

If the value does not exist, you also get yelled at:

{
  "code": "404",
  "message": "Key/value pair does not exist or is null."
}

But if it does exist, you get data:

{
    "code": 200,
    "data": "thing in a hash"
}

The end

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

Serverless URL Shortener made with Next.js + Redis.

linki: a place for your links linki is a url shortener made with next.js and redis! built with simplicity in mind, it's all in one page. deploy your o

Sep 15, 2022

A simple Node.js APIBAN client for downloading banned IPs and inserting them into a redis set

apiban-redis A simple Node.js APIBAN client for downloading banned IPs and inserting them into a redis set. Installation This utility can be run as a

Apr 5, 2022

This project demonstrates how you can use the multi-model capabilities of Redis to create a real-time stock watchlist application.

Introduction This project demonstrates how you can use Redis Stack to create a real-time stock watchlist application. It uses several different featur

Jan 2, 2023

Comments

Code cleanup and misc
js style lints

Added yarn lint - using semistandard. (feel free to switch to standard if desired, since there was an inconsistency of with and without semicolons)

Use switch case instead of if/else if

Use Array.forEach() instead of for const in

Consistency between functions and arrow functions

Only try parsing Redis response if it isn't parsed already (aka. type string)

Add string key support

Removed application/json setHeader due to redundancy (express already deals with this)

Misc inconsistencies fixed

Switched from node-redis to ioredis (probably better performance, lower size)

lock dependencies
opened by JeDaYoshi 2