Skip to content

NpgsqlRest/NpgsqlRest

 
 

Repository files navigation

NpgsqlRest

Build, Test, Publish and Release Tests 1700+ integration tests License GitHub Stars GitHub Forks

Automatic REST API for PostgreSQL | 6.1x faster than PostgREST

SQL files and PostgreSQL objects become REST endpoints. TypeScript clients are generated automatically.

"Simplicity is the ultimate sophistication." — Leonardo da Vinci

Most backend code shouldn't exist. If your API layer is just shuffling data between PostgreSQL and HTTP, why write it by hand? Write SQL, annotate it with a comment, and let the server figure out the rest. No controllers, no models, no mapping layers. The less code you maintain, the fewer bugs you ship.

NpgsqlRest Architecture

Install

Method Command
NPM npm i npgsqlrest
Docker docker pull vbilopav/npgsqlrest:latest
Direct Download Releases
.NET Library dotnet add package NpgsqlRest

Requires PostgreSQL >= 13. Native executables have zero runtime dependencies.

From SQL to REST API

Write a SQL file:

-- sql/process_order.sql
-- HTTP POST
-- @authorize admin
-- @result1 validate
-- @result3 confirm
-- @param $1 order_id
select count(*) as found from orders where id = $1;
update orders set status = 'processing' where id = $1;
select id, status from orders where id = $1;

That gives you POST /api/process-order:

{"validate": [1], "result2": 1, "confirm": [{"id": 42, "status": "processing"}]}

And a generated TypeScript client with full type safety:

export async function processOrder(orderid: number) : Promise<{
    validate: number[],
    result2: number,
    confirm: { id: number, status: string }[]
}> {
    const response = await fetch(baseUrl + "/api/process-order", {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ orderid }),
    });
    return await response.json();
}

No framework, no ORM, no boilerplate. Authorization, parameters, type safety — from a SQL file.

Endpoint Sources

Source What it's good for Example
SQL Files Simple queries, multi-command batch scripts, no DB deployment needed sql/get_users.sqlGET /api/get-users
Functions & Procedures Full PL/pgSQL power, static type checking, reusable logic get_user_by_id(int)GET /api/get-user-by-id
Tables & Views Automatic CRUD users table → GET/POST/PUT/DELETE /api/users

SQL files are the easiest way to get started — drop a .sql file in a folder and you have an endpoint. Functions give you the full power of PL/pgSQL with true end-to-end type checking. Use both together, or whichever fits.

All sources share the same annotation system: @authorize, @param, @cached, @path, and 50+ others.

Features

  • Multi-command SQL scripts — multiple statements in one file execute as a batch, returning named result sets
  • TypeScript/JS code generation and .http files — types flow from PostgreSQL to your frontend
  • AOT-compiled native binaries — zero dependencies, instant startup
  • 6.1x faster than PostgREST at 100 concurrent users
  • Auth — cookie auth, Basic auth, JWT claims, role-based access, @authorize, @allow_anonymous
  • Column-level encryption, security-sensitive endpoints, IP address binding
  • Response caching with per-endpoint expiration control
  • Rate limiting per endpoint
  • SSE streaming via RAISE INFO/NOTICE
  • File uploads — large objects, file system, MIME filtering
  • Reverse proxy — forward to upstream services
  • HTTP custom types — PostgreSQL functions that call external APIs
  • OpenAPI 3.0 spec generation
  • CSV/Excel and custom format response handlers

How does it compare?

NpgsqlRest vs PostgREST vs Supabase

Documentation

npgsqlrest.github.io — getting started, configuration, annotations, examples.

Contributing

Contributions are welcome. Open a pull request with a description of your changes.

License

MIT

About

Transform Your PostgreSQL Database into a Production-Ready, Blazing-Fast Standalone REST API Web Server With Static Type Checking and Automatic Code Generation

Topics

Resources

License

Contributing

Security policy

Stars

121 stars

Watchers

2 watching

Forks

Sponsor this project

Packages

 
 
 

Contributors

Languages