Skip to content

Latest commit

 

History

History
29 lines (27 loc) · 1.44 KB

README.md

File metadata and controls

29 lines (27 loc) · 1.44 KB

Gunpoint API

Docker ? Issues ? Stars ? Forks ?

Gunpoint is a restful API for Gun. You can fire it up with :

npm run start

Instead of downloading it, you can use the Docker package by using :

docker pull ghcr.io/noctisatrae/gunpoint:master


If you want to try Gunpoint, it's here ! (Main playground running latest release)
If you want to test the new features, click here ! (Devlopment playground)

By the way, take a look at what's comming next :

    • Websocket support
    • GraphQL URI
    • A /set URI using gun.set()
    • Be able to submit array (array to JS Object function)
    • Be able to configure Gun with config.json
    • Docker image with CI on master branch

What you can do, currently :

/get/[key]: Use it to get data from a definied graph (GET request).
/put/[key] + request body (in JSON): Add data in a specified graph (POST request).
/put/[graph 1]/in/[graph 2]: Put the graph 1 in the graph 2 (POST request).
/delete/[data]/in/[graph]: Delete defined data in a specified graph (DELETE request).