roapi
為緩慢變動的資料集建立功能完整的 API,無需撰寫任何程式碼。
roapi 是什麼?
為緩慢變動的資料集建立功能完整的 API,無需撰寫任何程式碼。
roapi 概覽
這是什麼
ROAPI 能自動為靜態資料集建立唯讀 API,無需撰寫任何程式碼。它基於 Apache Arrow 和 Datafusion 建構。核心設計包含查詢前端(將 SQL、FlightSQL、GraphQL 和 REST API 查詢轉譯為 Datafusion 計畫)、Datafusion 執行查詢計畫、資料層(從多種來源與格式載入資料集並自動推論結構描述),以及回應編碼層(將中間的 Arrow 記錄批次序列化為客戶端要求的各種格式)。
主要功能
- 查詢層:REST API GET、GraphQL、SQL、資料表聯結、依索引存取陣列元素、依鍵存取巢狀結構欄位、Postgres 協定、FlightSQL、鍵值查詢 - 回應序列化:JSON (
application/json)、Arrow (application/vnd.apache.arrow.stream)、Parquet (application/vnd.apache.parquet) - 資料層:檔案系統、HTTP/HTTPS、S3、GCS、Azure Storage、Google 試算表、MySQL、SQLite、Postgres - 資料格式:CSV、JSON、NDJSON、parquet、xls、xlsx、xlsb、ods、DeltaLake - 支援 YAML 或 Toml 設定檔,可設定進階表格選項 - 透過 API 動態註冊資料表
使用情境
ROAPI 適用於變動緩慢的資料集,無需撰寫後端程式碼即可透過多種查詢介面(SQL、GraphQL、REST)公開資料。適合分析、資料探索,以及為靜態或更新頻率低的資料來源建立輕量 API。
快速開始
透過 Homebrew 或 pip 安裝: bash brew install roapi # 或 pip install roapi 使用範例資料快速啟動: bash roapi --table 'uk_cities=test_data/uk_cities_with_headers.csv' --table 'test_data/spacex_launches.json' 或使用 Docker: bash docker run -t --rm -p 8080:8080 ghcr.io/roapi/roapi:latest --addr-http 0.0.0.0:8080 --table 'uk_cities=test_data/uk_cities_with_headers.csv' --table 'test_data/spacex_launches.json' 透過 SQL、GraphQL 或 REST 查詢資料: bash curl -X POST -d 'SELECT city, lat, lng FROM uk_cities LIMIT 2' localhost:8080/api/sql curl -X POST -d 'query { uk_cities(limit: 2) {city, lat, lng} }' localhost:8080/api/graphql curl 'localhost:8080/api/tables/uk_cities?columns=city,lat,lng&limit=2'
授權與價格
採用 Apache-2.0 授權。開放原始碼。
內容整理自該專案公開的 README 與儲存庫資訊。