https://github.com/mustafah15/cache-api

https://github.com/mustafah15/cache-api

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mustafah15/cache-api
• Owner: mustafah15
• Created: 2020-01-07T11:05:54.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T05:11:29.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T06:12:26.095Z (7 months ago)
• Language: JavaScript
• Size: 384 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cache api

This project is provides APIs for CRUD operations to cache resources and it handles all the logic according to the spec file.

## installation

- run the docker image it will build the project container and all it's dependencies

-  for starting the server 

```

npm run start

```

```

cp .env-example .env

npm run docker

```

- for running the tests

```

npm run test

```

- for checking the lint

```

npm run lint

```

- for checking tests coverage

```

npm run coverage

```

##  usage

### GET request to /cache

this for list all the cache objects

### GET request to /cache/{key}

for getting specific cache object by it's key

### POST request to /cache/{key}

### PUT request to /cache/{key}

for creating a new cache object if this key does not exists before if it exists it will update the data with the provided data in the body.

### DELETE request to /cache/{key}

this will delete an object by it's key

### DELETE request to /cache

this for deleting all the database