GithubHelp home page GithubHelp logo

kevbob1 / zoorest Goto Github PK

View Code? Open in Web Editor NEW

This project forked from difrex/zoorest

0.0 1.0 0.0 70 KB

Zookeeper REST API

License: GNU General Public License v3.0

Go 94.54% Shell 2.84% Dockerfile 2.62%

zoorest's Introduction

Zoorest

Build Status

Zookeeper REST API

Table of Contents

Usage

Usage of ./zoorest:
  -listen string
    	Address to listen (default "127.0.0.1:8889")
  -mc
    	Enable memcached support
  -mchosts string
    	Memcached servers. Comma separated (default "127.0.0.1:11211")
  -mcprefix string
    	Memcached key prefix (default "zoorest")
  -path string
    	Zk root path (default "/")
  -zk string
    	Zk servers. Comma separated (default "127.0.0.1:2181")

NOTE: If memcached support is enabled zkStat metrics will not be returned.

Typical usage scheme:

tupical usage

CORS

Cross-origin resource sharing is a feature that securely allows access to a zoorest instance from a web browser. This is an optional feature and is disabled by default. It is enabled and configured via OS environment variables.

ZOOREST_CORS_ENABLE enable the feature. Any non-empty value is considered "true" and enables it. default: false

ZOOREST_CORS_DEBUG_ENABLE enable CORS debug mode Any non-null value is considered "true" and enables it. default: false

ZOOREST_CORS_ALLOWED_ORIGINS comma delimited list of origin url patterns to allow access to the service. default: * (any origin)

API v1

List node childrens

Method: GET

Location: /v1/ls

Return JSON

curl -s -XGET http://127.0.0.1:8889/v1/ls/ | jq
{
  "childrens": [
    "two",
    "three",
    "one"
  ],
  "path": "/zoorest",
  "state": "OK",
  "error": ""
}

Errors

curl -s -XGET http://127.0.0.1:8889/v1/ls/does/not/exist | jq
{
  "childrens": null,
  "path": "",
  "state": "ERROR",
  "error": "zk: node does not exist"
}

Get node data

Method: GET

Location: /v1/get

Return JSON

curl -s -XGET http://127.0.0.1:8889/v1/get/one/data | jq
{
  "path": "/zoorest/one/data",
  "state": "OK",
  "error": "",
  "data": "eyJzb21lIjogImpzb24ifQ=="
}

Node data stored in data field as base64 encoded string

echo eyJzb21lIjogImpzb24ifQ== | base64 -d
{"some": "json"}

Errors

 curl -s -XGET http://127.0.0.1:8889/v1/get/does/not/exist | jq
{
  "path": "",
  "state": "ERROR",
  "error": "zk: node does not exist",
  "data": null
}

Get node data as JSON

Method: GET

Location: /v1/get/path/to/node+json

Simple add to the end of the path +json Return JSON

curl -s -XGET http://127.0.0.1:8889/v1/json/one/data+json | jq
{
  "path": "/json/one/data",
  "state": "OK",
  "error": "",
  "zkstat": {
    "Czxid": 45,
    "Mzxid": 55,
    "Ctime": 1564645641612,
    "Mtime": 1564646317882,
    "Version": 6,
    "Cversion": 0,
    "Aversion": 0,
    "EphemeralOwner": 0,
    "DataLength": 28,
    "NumChildren": 0,
    "Pzxid": 45
  },
  "data": {
    "ok": true,
    "some": "data"
  }
}

Errors

curl -s -XGET http://127.0.0.1:8889/v1/get/invalid/json+json | jq
{
  "path": "/invalid/json",
  "state": "ERROR",
  "error": "JSON parsing failure: invalid character 'i' looking for beginning of value",
  "zkstat": {
    "Czxid": 45,
    "Mzxid": 56,
    "Ctime": 1564645641612,
    "Mtime": 1564646350753,
    "Version": 7,
    "Cversion": 0,
    "Aversion": 0,
    "EphemeralOwner": 0,
    "DataLength": 17,
    "NumChildren": 0,
    "Pzxid": 45
  },
  "data": null
}

Create node recursive

Method: PUT

Location: /v1/up

Return string with created path

curl -XPUT http://127.0.0.1:8889/v1/up/two/three/four -d '{"four": "json"}'
/zoorest/two/three/four

Create node children

Method: PATCH

Location: /v1/up

Return string with created children path

curl -XPATCH http://127.0.0.1:8889/v1/up/one/test -d 'test'
/one/test

Errors

curl -XPATCH http://127.0.0.1:8889/v1/up/six/test -d '{"six": "json"}'
zk: node does not exist

Update node

Method: POST

Location: /v1/up

Return string with updated path

curl -XPOST http://127.0.0.1:8889/v1/up/two -d '{"two": "json"}'
/zoorest/two

Errors

curl -XPOST http://127.0.0.1:8889/v1/up/twa -d '{"two": "json"}'
zk: node does not exist

Delete node recursive

Method: DELETE

Location: /v1/rmr

Return string with removed path

curl -XDELETE http://127.0.0.1:8889/v1/rmr/two
/zoorest/two

API v2

List node childrens

Method: LIST

Return JSON

curl -s -XGET http://127.0.0.1:8889/v2/ | jq
{
  "childrens": [
    "two",
    "three",
    "one"
  ],
  "path": "/zoorest",
  "state": "OK",
  "error": ""
}

Errors

curl -s -XGET http://127.0.0.1:8889/v2/does/not/exist | jq
{
  "childrens": null,
  "path": "",
  "state": "ERROR",
  "error": "zk: node does not exist"
}

Get node data

Method: GET

Return JSON

curl -s -XGET http://127.0.0.1:8889/v2/one/data | jq
{
  "path": "/zoorest/one/data",
  "state": "OK",
  "error": "",
  "data": "eyJzb21lIjogImpzb24ifQ=="
}

Node data stored in data field as base64 encoded string

echo eyJzb21lIjogImpzb24ifQ== | base64 -d
{"some": "json"}

Errors

 curl -s -XGET http://127.0.0.1:8889/v2/does/not/exist | jq
{
  "path": "",
  "state": "ERROR",
  "error": "zk: node does not exist",
  "data": null
}

Get node data as JSON

Method: GET

Location: /v2/path/to/node+json

Simple add to the end of the path +json Return JSON

curl -s -XGET http://127.0.0.1:8889/v2/json/one/data+json | jq
{
  "path": "/json/one/data",
  "state": "OK",
  "error": "",
  "zkstat": {
    "Czxid": 45,
    "Mzxid": 55,
    "Ctime": 1564645641612,
    "Mtime": 1564646317882,
    "Version": 6,
    "Cversion": 0,
    "Aversion": 0,
    "EphemeralOwner": 0,
    "DataLength": 28,
    "NumChildren": 0,
    "Pzxid": 45
  },
  "data": {
    "ok": true,
    "some": "data"
  }
}

Errors

curl -s -XGET http://127.0.0.1:8889/v2/invalid/json+json | jq
{
  "path": "/invalid/json",
  "state": "ERROR",
  "error": "JSON parsing failure: invalid character 'i' looking for beginning of value",
  "zkstat": {
    "Czxid": 45,
    "Mzxid": 56,
    "Ctime": 1564645641612,
    "Mtime": 1564646350753,
    "Version": 7,
    "Cversion": 0,
    "Aversion": 0,
    "EphemeralOwner": 0,
    "DataLength": 17,
    "NumChildren": 0,
    "Pzxid": 45
  },
  "data": null
}

Create node recursive

Method: PUT

Return string with created path

curl -XPUT http://127.0.0.1:8889/v2/two/three/four -d '{"four": "json"}'
/zoorest/two/three/four

Create node children

Method: PATCH

Return string with created children path

curl -XPATCH http://127.0.0.1:8889/v2/one/test -d 'test'
/one/test

Errors

curl -XPATCH http://127.0.0.1:8889/v2/six/test -d '{"six": "json"}'
zk: node does not exist

Update node

Method: POST

Return string with updated path

curl -XPOST http://127.0.0.1:8889/v2/two -d '{"two": "json"}'
/zoorest/two

Errors

curl -XPOST http://127.0.0.1:8889/v2/twa -d '{"two": "json"}'
zk: node does not exist

Delete node recursive

Method: DELETE

Return string with removed path

curl -XDELETE http://127.0.0.1:8889/v2/two
/zoorest/two

Errors

curl -XPOST http://127.0.0.1:8889/v2/two
Method POST not alowed

Build

Binary

Set GOPATH variable

export GOPATH ${HOME}/.local

Get source code

go get github.com/Difrex/zoorest/rest

Get dependencies

cd ${GOPATH}/src/github.com/Difrex/zoorest
go get -t -v ./...

Build staticaly linked binary

go build -ldflags "-linkmode external -extldflags -static"

Build dynamicaly linked binary

go build

Build dynamicaly linked binary with gcc

go build -compile gccgo

Docker build

Binary file

Build binary with the Docker

git clone https://github.com/Difrex/zoorest.git
cd zoorest
./build.sh docker-binary

Result binary file will be placed in out/ dir

Docker image

Build Alpine based docker image

git clone https://github.com/Difrex/zoorest.git
cd zoorest
./build.sh docker

Image will be tagged as zoorest:latest

Get docker image

Pull image

docker pull lessmore/zoorest

And run it

/usr/bin/docker run -d -p 8889:8889 --name zoorest lessmore/zoorest:latest --zk zoo1:2181,zoo2:2181,zoo3:2181 --path /zoorest/jail --listen 0.0.0.0:8889 -mc -mchosts mc1:11211,mc2:11211,mc3:11211

AUTHORS

Denis Zheleztsov [email protected]

LICENSE

GPLv3 see LICENSE

DONATE

BTC 1JCmZQdESKPCrcjUxDRNgt5HaSgUEWZ8pV
DASH XxEWcJgfiAav1gxTtVLGXqE5T66uMA7te7

zoorest's People

Contributors

difrex avatar kevbob1 avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.