README
¶
pRESTd
pREST (PostgreSQL REST), is a simple production-ready API, that delivers a instant, realtime, and high-performance application on top of your existing or new Postgres database.
PostgreSQL version 9.5 or higher
Contributor License Agreement -
Problems we solve
The pREST project is the API that addresses the need for fast and efficient solution in building RESTful APIs on PostgreSQL databases. It simplifies API development by offering:
- A lightweight server with easy configuration;
- Direct SQL queries with templating in customizable URLs;
- Optimizations for high performance;
- Enhanced developer productivity;
- Authentication and authorization features;
- Pluggable custom routes and middlewares.
Overall, pREST simplifies the process of creating secure and performant RESTful APIs on top of your new or old PostgreSQL database.
Why we built pREST
When we built pREST, we originally intended to contribute and build with the PostgREST project, although it took a lot of work as the project is in Haskell. At the time, we did not have anything similar or intended to keep working with that tech stack. We've been building production-ready Go applications for a long time, so building a similar project with Golang as its core was natural.
Additionally, as Go has taken a huge role in many other vital projects such as Kubernetes and Docker, and we've been able to use the pREST project in many different companies with success over the years, it has shown to be an excellent decision.
1-Click Deploy
Heroku
Deploy to Heroku and instantly get a realtime RESTFul API backed by Heroku Postgres:
Documentation
Visit https://docs.prestd.com/
Documentation
¶
Overview ¶
pREST - Serves a RESTful API from any SQL database
Install
go install github.com/prest/prest
Run
Params: - PREST\_HTTP_PORT (default 3000) - PREST\_PG_HOST (default 127.0.0.1) - PREST\_PG_USER - PREST\_PG_PASS - PREST\_PG_DATABASE - PREST\_PG_PORT - PREST\_JWT_KEY ``` PREST_PG_USER=postgres PREST_PG_DATABASE=prest PREST_PG_PORT=5432 PREST_HTTP_PORT=3010 prest # Binary installed ```
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
mockgen
Package mockgen is a generated GoMock package.
|
Package mockgen is a generated GoMock package. |
|
lib
|
|
|
src
nolint all plugins must have their package name as `main` each plugin is isolated at compile time
|
nolint all plugins must have their package name as `main` each plugin is isolated at compile time |
|
src/middlewares
nolint all plugins must have their package name as `main` each plugin is isolated at compile time
|
nolint all plugins must have their package name as `main` each plugin is isolated at compile time |