CodeCow/roapi
1
0
Fork 0
mirror of https://github.com/roapi/roapi.git synced 2026-06-05 21:04:02 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

link to user doc in readme

Browse Source
This commit is contained in:
Qingping Hou 2021-02-27 22:00:02 -08:00
parent b99b3abceb
commit fe9543163d
2 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Cargo.toml
View File

@ -14,3 +14,7 @@ actix-web = { git = "https://github.com/actix/actix-web.git", rev = "b37669cb3b4
actix-http = { git = "https://github.com/actix/actix-web.git", rev = "b37669cb3b47eeb60c161ff12156d1c877af91a2" }
awc = { git = "https://github.com/actix/actix-web.git", rev = "b37669cb3b47eeb60c161ff12156d1c877af91a2" }
actix-cors = { git = "https://github.com/houqp/actix-extras.git", rev = "ab3bdb6a5924b6d881d204856199e7539e273d2f" }
# arrow = { path = "/home/houqp/Documents/code/delta/arrow/rust/arrow" }
# parquet = { path = "/home/houqp/Documents/code/delta/arrow/rust/parquet" }
# datafusion = { path = "/home/houqp/Documents/code/delta/arrow/rust/datafusion" }

28
README.md
View File

@ -2,6 +2,7 @@
# ROAPI
![build](https://github.com/roapi/roapi/workflows/build/badge.svg)
[![Documentation](https://img.shields.io/badge/-documentation-blue)](https://roapi.github.io/docs/index.html)
ROAPI automatically spins up read-only APIs for static datasets without
requiring you to write a single line of code. It builds on top of [Apache
@ -9,13 +10,16 @@ Arrow](https://github.com/apache/arrow) and
[Datafusion](https://github.com/apache/arrow/tree/master/rust/datafusion). The
core of its design can be boiled down to the following:
* Query frontends to translate SQL, GraphQL and REST API queries into
* [Query frontends](https://roapi.github.io/docs/api/query/index.html) to
translate SQL, GraphQL and REST API queries into
Datafusion plans.
* Datafusion for query plan execution.
* Data layer to load datasets from a variety of sources and formats with
automatic schema inference.
* Response encoding layer to serialize intermediate Arrow record batch into
various formats requested by client.
* [Data layer](https://roapi.github.io/docs/config/dataset-formats/index.html)
to load datasets from a variety of sources and formats with automatic schema
inference.
* [Response encoding layer](https://roapi.github.io/docs/api/response.html) to
serialize intermediate Arrow record batch into various formats requested by
client.
See below for a high level diagram:
@ -37,7 +41,7 @@ Spin up APIs for `test_data/uk_cities_with_headers.csv` and
```bash
roapi-http \
--table 'uk_cities:test_data/uk_cities_with_headers.csv'
--table 'uk_cities:test_data/uk_cities_with_headers.csv' \
--table 'spacex_launches:test_data/spacex-launches.json'
```
@ -107,6 +111,10 @@ To run serve tables using config file:
roapi-http -c ./roapi.yml
```
See [config
documentation](https://roapi.github.io/docs/config/config-file.html) for more
options.
### Google spreadsheet as table source
@ -140,8 +148,8 @@ tables:
### Response serialization
By default, roapi encodes responses in JSON format, but you can request
different encoding by specifying the `ACCEPT` header:
By default, ROAPI encodes responses in JSON format, but you can request
different encodings by specifying the `ACCEPT` header:
```
curl -X POST \
@ -174,7 +182,7 @@ example predicate `0 <= col2 < 5` can be expressed as
### GraphQL query interface
To query tables through GraphQL, send the query through `POST` request to
To query tables using GraphQL, send the query through `POST` request to
`/api/graphql` endpoint.
GraphQL query interface supports the same set of operators supported by REST
@ -203,7 +211,7 @@ API. Here how you can apply various operators to your query:
### SQL query interface
To query tables through a subset of standard SQL, send the query through `POST`
To query tables using a subset of standard SQL, send the query through `POST`
request to `/api/sql` endpoint. This is the only query interface that supports
table joins.