Skip to content

krishvsoni/cache-db

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cache-DB Endpoints Usage

1. Set Cache Data (GET Request)

  • URL:
    GET http://localhost:3000/userdb1/set?key=myKey&value=myValue&ttl=10

2. Get Cache Data (GET Request)

  • URL:
    GET http://localhost:3000/userdb1/get?key=myKey

Set Cache Data (POST Request)

Endpoint Details

  • URL:
    http://localhost:3000/{db_name}/set
  • Method:
    POST

Request Body

{
        "key": "myKey",
        "value": "myValue",
        "ttl": 10
}

Example Request

  • URL:
    http://localhost:3000/userdb1/set
  • Method:
    POST
  • Body:
    {
            "key": "myKey",
            "value": "myValue",
            "ttl": 10
    }

Expected Responses

Success Response:

{
        "message": "Cache set successfully!"
}

Failure Response (Missing Parameters):

{
        "message": "Missing required parameters: key, value, ttl"
}

Get Cache Data (GET Request)

Endpoint Details

  • URL:
    http://localhost:3000/{db_name}/get
  • Method:
    GET

URL Parameters

  • key: The cache key you want to retrieve.

Example Request

  • URL:
    http://localhost:3000/userdb1/get?key=myKey
  • Method:
    GET

Expected Responses

Success Response:

{
        "key": "myKey",
        "value": "myValue"
}

Failure Response (Missing Key):

{
        "message": "Key is required"
}

Failure Response (Cache Expired or Not Found):

{
        "key": "myKey",
        "value": null
}

About

an opensource alternative of redis

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published