PostgREST

What is PostgREST

PostgREST is a powerful backend server that transforms your PostgreSQL database into a fully functional RESTful API, providing a faster, cleaner, and more standards-compliant solution than building one from scratch.

By using PostgREST, you can create a RESTful API for your existing PostgreSQL database in no time, without the need for complex coding or configuration. Additionally, PostgREST utilizes the OpenAPI standard to generate comprehensive and up-to-date API documentation, making it easier to maintain and scale your API.

To take things to the next level, you can use a tool like Swagger-UI to render interactive documentation for demo requests against the live API server, improving the user experience and making it easier to onboard new developers. In short, PostgREST is an excellent choice for anyone looking to build a fast, reliable, and scalable RESTful API from their PostgreSQL database. Try it today and see the benefits for yourself!

What does PostgREST stack include

• PostgreSQL server
• Preconfigured JWT token authentication

Who is using PostgREST

• Frontend Web Developers
• REST API developers who know Haskel

What are the benefits of using PostgREST

• Open-source
• Painless updates and easy rollbacks

Why using PostgREST

PostgREST provides a compelling alternative to manual CRUD programming. Custom API servers can encounter various issues, such as duplicating, ignoring, or compromising the database structure while writing business logic. Additionally, object-relational mapping can create leaky abstractions that result in slow, imperative code.

PostgREST takes a different approach by promoting a philosophy that centers around a single declarative source of truth: the data itself. This approach helps to eliminate the problems caused by custom API servers and object-relational mapping by providing a more efficient and intuitive way to create RESTful APIs.

By using PostgREST, you can bypass the need for custom coding and rely on the declarative nature of your database to generate a fully functional API. This approach saves time and effort while improving the performance and scalability of your API.

In conclusion, PostgREST offers a fresh perspective on creating APIs by focusing on the data and removing the need for custom coding. If you want to avoid the common problems associated with custom API servers and object-relational mapping, give PostgREST a try today!

What's next ?

Once deployment is complete, and you have received a notification email with a PDF file attached, you can find your new server's IP in the "User info and SSH Access" section of the document. Copy the IP from the PDF and insert it into the browser URL, adding the :8080 port as follows:

https://<YOURSERVER_IP>:8080

This will allow you to view all available endpoints of the postgrest server.

Let's try testing how the login endpoint works:

1. Find the login endpoint (rpc) on the Swagger page and click the "Try Out" button.
2. Fill up the email and password fields.

Please note that "<YOURSERVER_IP>" should be replaced with the actual IP address obtained from the PDF.

email:     admin
password:  admin

Example response:

curl -X 'GET' \  'http://<YOUR_SERVER_IP_HERE>:3000/rpc/login?email=admin&pass=admin' \   
-H 'accept: application/json'

CodeDetails

403
Undocumented
Error: Forbidden

Response body
{  
    "code": "28P01",  
    "details": null,  
    "hint": null,  
    "message": 
    "invalid user or password" 
}
Response headers
content-type: application/json; charset=utf-8  
date: Fri,21 Jul 2023 13:49:10 GMT  
server: postgrest/11.1.0  
transfer-encoding: chunked

Number of servers required:

Single VPS server