pREST was developed with the possibility of using it as a web framework, being able to use it based on its API, you create new endpoints and place middleware, adapting the pREST to your need.
In order to create custom modules for pREST you need extends the router and register the custom new routes.
package main
import (
"net/http"
"github.com/prest/prest/adapters/postgres"
"github.com/prest/prest/cmd"
"github.com/prest/prest/config"
"github.com/prest/prest/config/router"
"github.com/prest/prest/middlewares"
)
func main() {
config.Load()
// Load Postgres Adapter
postgres.Load()
// Get pREST app
middlewares.GetApp()
// Get pPREST router
r := router.Get()
// Register custom routes
r.HandleFunc("/ping", Pong).Methods("GET")
// Call pREST cmd
cmd.Execute()
}
func Pong(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Pong!"))
}
All you need to know about all the API routes, please view the following links for more details.
| Route | Description | Method | Details |
|---|---|---|---|
/databases |
databases list | GET | link |
/schemas |
schemas list | GET | link |
/tables |
tables list | GET | link |
/_QUERIES/custom/{script} |
executes a custom query | depends | link |
/{database}/{schema} |
schema of a database | GET | link |
/{database}/{schema}/{table} |
select fields from a table | GET | link |
/{database}/{schema}/{table} |
insert into a table | POST | link |
/batch/{database}/{schema}/{table} |
batch insert into a table | POST | link |
/{database}/{schema}/{table} |
delete from table | DELETE | link |
/{database}/{schema}/{table} |
update on table | PUT, PATCH | link |
Should return all databases visible in json list format.
/databasesGETShould return all schemas available in the databases in json list format.
/schemasGETShould return all tables available in the databases in json list format.
/tablesGETPremium feature, should always return a json according to the custom query given.
/tablesdepends on the custom queryShould return the database schema
/{database}/{schema}GETCRUD operations over tables can carry url query params to allow higher complexity queries, they are listed bellow. Possible query URL params:
_columns: column names to get from table_distinct: if the returns should have distinct values (needs to be set to “true”)_groupby: if the results should be grouped by a column, value should be the name of a column_orderby: if the results should be ordered by a column, value should be the name of a column_count: if the results should count a value of a column, value should be the name of a column_join: if the result should make a join operation with another table, this value has 5 arguments divided by ‘:’. Example: https://example.com/?_join=<join_type(inner|left|right)>:<schema>.<table_B>:<table_B>.<column>:<operator(=)>:<table_A>.<column>_page: if the result should be paginated, this is the number of the page to be returned_page_size: number of objects to be returned on a paginated responsewhere by clause: columns can be filtered by using the
column=<value>expression on url params
Should get information from a table using the CRUD query params as filters.
/{database}/{schema}/{table}GETShould try to insert the json object given on body to the given table on path.
/{database}/{schema}/{table}POSTShould try to delete a
/{database}/{schema}/{table}POSTShould try to update a table with the given url query params.
/{database}/{schema}/{table}PUT, PATCHShould try to do the insert batch on a table, using the request body as the insert data.
/batch/{database}/{schema}/{table}POST