https://github.com/synthesized-io/jdbcrest
Java reimplementation of PostgREST
https://github.com/synthesized-io/jdbcrest
api automatic-api database http java jdbc rest restful server sql
Last synced: about 3 hours ago
JSON representation
Java reimplementation of PostgREST
- Host: GitHub
- URL: https://github.com/synthesized-io/jdbcrest
- Owner: synthesized-io
- License: apache-2.0
- Created: 2026-02-16T11:40:46.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-06-12T17:11:00.000Z (8 days ago)
- Last Synced: 2026-06-12T18:23:41.585Z (8 days ago)
- Topics: api, automatic-api, database, http, java, jdbc, rest, restful, server, sql
- Language: Java
- Homepage:
- Size: 94.7 KB
- Stars: 9
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JDBCRest
JDBCRest is a Java library and a standalone server that turns your JDBC-accessible database directly into a RESTful API. The structural constraints and permissions in the database determine the API endpoints and operations. This project is heavily inspired by [PostgREST](https://postgrest.org).
Conceptually, JDBCRest is:
- **[PostgREST](https://postgrest.org) reimplemented in Java**
- Generalized from **PostgreSQL-only** to **JDBC-backed databases**
## Comparison with PostgREST
JDBCRest aims to be compatible with PostgREST's API surface while extending its capabilities to any database with a JDBC driver.
To ensure behavioral parity, the project includes a suite of **comparison tests** that run against both PostgREST and JDBCRest. These tests use PostgREST as the behavioral reference, executing the same operations against multiple backends and implementations to verify consistency.
## Documentation
See [product documentation](docs/index.adoc).
## Requirements
- Java 17 or higher
## Quick Start
### Build
```shell
mvn clean install -DskipTests
```
### Run standalone server
JDBCRest can be run as a standalone server. You can configure it using Spring Boot properties.
```shell
java -Dspring.datasource.url=jdbc:postgresql://localhost:5432/mydb \
-Dspring.datasource.username=myuser \
-Dspring.datasource.password=mypass \
-Dspring.datasource.driver-class-name=org.postgresql.Driver \
-Djdbcrest.database-type=JOOQ_POSTGRES \
-jar cli/target/jbdcrest-cli.jar
```
### Usage as a Library
Add the following dependency to your `pom.xml`:
```xml
io.synthesized
jdbcrest-core
1.0.0-SNAPSHOT
```
## jOOQ Dependency Policy
By default, this open-source project relies on the open-source version of jOOQ. However, if your organization uses jOOQ Pro, you can benefit from support for additional database types, such as SAP HANA.
The jOOQ dependency in the `core` module is marked as **optional**. This allows you to exclude the default jOOQ dependency and provide your own version (e.g., jOOQ Pro) in your project's `pom.xml`.
If you want to develop or test jOOQ Pro specific features in this library, use the `jooq-pro` Maven profile:
```shell
mvn clean install -Pjooq-pro
```
## Publishing a new version to Maven Central
```shell
mvn -Ppublish-central clean deploy
```