Workers-KV-api

api implementation to manage Cloudflare Workers KV

Notice

The Workers includes limited KV Usage. When adding KV records from the offical website, it's doing read function for lots times, it's expensive to do such behavior.

This api has GET POST PUT DELETE OPTIONS methods, for public use, you can comment code block of some methods to protect your data.

Design

api.example.com / v1 / db / test;

/*
@v1:     api version
@db:     api service
@test:   key
*/

Methods

• POST & PUT methods example

/*
header 'Content-Type' can be ignored
@value
*/

/*
@db service
@path: /v1/db
@methods: GET POST PUT DELETE
*/

curl -X "POST" "http://localhost:8787/v1/db/a" -d '{"value": "apple"}'

curl -X "PUT" "http://localhost:8787/v1/db/ab" -d '{"value": "a banana"}'

/*
@search service
@path: /v1/search
@methods: GET
*/

curl -X "GET" "http://localhost:8787/v1/search/a"

/*
!!Danger Zone
move = db (DELETE + POST/PUT)

@move service
@path: /v1/move
@methods: PUT
*/

curl -X "PUT" "http://localhost:8787/v1/move/a" -d '{"newKey": "bpple", "value": "a banana"}'

Deploy

1. create a worker

2. paste the code from api.js

3. set KV database binding

4. create records in KV database

5. set route for api.example.com

6. create DNS record for api.example.com

Reference

Workers KV API reference

Powered by

Cloudflare Workers

License

MIT