Skip to content
Microservice query language
Clojure Shell Dockerfile
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker/nginx
docs
examples
ops/k8s
roadmap meetings
scripts
src
test
.dockerignore
.editorconfig
.gitignore
.travis.yml
CHANGELOG.md
Dockerfile
LICENSE
README.md
docker-compose.yml
project.clj

README.md

restQL

restQL-http is a server to run restQL queries, making easy to fetch information from multiple services in the most efficient manner

restQL on travis-ci

Getting Started

Running restQL HTTP

restQL server allows you to post ad-hoc queries and to reference resources pre-configured in the server startup.

  1. Make sure you have Java 11 or superior installed,
  2. Download the latest release in the release page,
  3. Unzip the package,
  4. Configure resource mappings,
  5. Run bin/run.sh.

Post to http://your-server.ip:9000/run-query the body below and content-type text/plain:

curl -H "Content-Type: text/plain" localhost:9000/run-query -d "from planets as allPlanets" 

For a more complex example follow this tutorial. Alternatively you can use our official docker image.

Our query language

The clause order matters when making restQL queries. The following is a full reference to the query syntax, available clauses and order.

[ [ use modifier = value ] ]

METHOD resource-name [as some-alias] [in some-resource]
  [ headers HEADERS ]
  [ timeout INTEGER_VALUE ]
  [ with WITH_CLAUSES ]
  [ [only FILTERS] OR [hidden] ]
  [ [ignore-errors] ]

e.g:

from search
    with
        role = "hero"

from hero as heroList
    with
        name = search.results.name

Learn more about restQL query language

Links

Reach the community

Who's talking about restQL

To Do

  • Create endpoints for creating and updating queries and resources (#178)
  • Implement a soft cache reset when resources are created or updated (#179)
  • Unify cache locations in restQL-http (#180)

License

Copyright © 2016-2019 B2W Digital

Distributed under the MIT License.

You can’t perform that action at this time.