API Server
Contribution
Deployment

Docs Menu

API Server

Setup

Docker

Prerequisites
Quick Start
- Network config
With Docker Compose
First call on API

Heroku Guide

Prerequisites
Quick Start

Homebrew

Prerequisites
Quick Start

Golang

Prerequisites
Quick Start

Development Guides

Development usage
Dev Container
- GitHub Codespaces
  - How to use the prestd in Codespaces
Next step in development
Execute unit tests locally (integration/e2e)
Version - Patterns

API reference

Endpoints

GET
POST
PATCH and PUT
DELETE

Parameters

Filters
- Functions support
Operators

Auth

Bearer
Basic

Advanced Queries

Filter range
JOIN
JSONb support
- Example of how to do insertion via cURL
Full Text Search (with tsquery)
- - Set language
Batch Insert

Custom Queries

Scripts templates rules
Template data
Template functions
- isSet
- defaultOrValue
- inFormat
- split
- limitOffset
Ready-made queries

Plugins

Naming patterns
- File name
- Function name
Process of building
Example

Plugins

Endpoint Plugin

Naming patterns
- File name
- Function name
Example

Middleware Plugin

Naming patterns
- Filename
- Function name
Example

Deployment

Server Configuration

Environment variables
TOML
Authorization
- JWT
White list
Auth
Expose Data
- Default values for Exposure Settings
SSL
Debug Mode
Single mode - multi database (PostgreSQL)
CORS support
Health check endpoint

Permissions

Cache

Data Architecture
- Because BuntDB
Configuration for specific endpoint ("advanced")
Environment vars
TOML

Migrations

Filename Format
Content Format
Reversibility of Migrations

CORS Support

Integrations

YugabyteDB

TimescaleDB

Docker Compose
Starting up the containers
Creating database structure
Loading data
Simple Query
Joining tables
Using VIEWs
Batch Insert data

Amazon Redshift

Case studies

Companies

Setup

Docker

Prerequisites
Quick Start
- Network config
With Docker Compose
First call on API

Heroku Guide

Prerequisites
Quick Start

Homebrew

Prerequisites
Quick Start

Golang

Prerequisites
Quick Start

Development Guides

Development usage
Dev Container
- GitHub Codespaces
  - How to use the prestd in Codespaces
Next step in development
Execute unit tests locally (integration/e2e)
Version - Patterns

API reference

Endpoints

GET
POST
PATCH and PUT
DELETE

Parameters

Filters
- Functions support
Operators

Auth

Bearer
Basic

Advanced Queries

Filter range
JOIN
JSONb support
Full Text Search (with tsquery)
- - Set language
Batch Insert

Custom Queries

Scripts templates rules
Template data
Template functions
- isSet
- defaultOrValue
- inFormat
- split
- limitOffset
Ready-made queries

Plugins

Naming patterns
- File name
- Function name
Process of building
Example

Deployment

Server Configuration

Environment variables
TOML
Authorization
- JWT
White list
Auth
Expose Data
- Default values for Exposure Settings
SSL
Debug Mode
Single mode
CORS support
Health check endpoint

Permissions

Cache

Data Architecture
- Because BuntDB
Configuration for specific endpoint ("advanced")
Environment vars
TOML

Migrations

Filename Format
Content Format
Reversibility of Migrations

CORS Support

Integrations

YugabyteDB

TimescaleDB

Docker Compose
Starting up the containers
Creating database structure
Loading data
Simple Query
Joining tables
Using VIEWs
Batch Insert data