... | ... | @@ -31,7 +31,7 @@ Some queries may return large volumes of data. For example, the above query to ~ |
|
|
- limit :: Set the maximum number of records to be returned
|
|
|
- offset :: Index of the first record to be returned (starting from 0)
|
|
|
|
|
|
For example, the following query results in 3 records from ~/fred_domains~ to be returned, starting from record #1 (second in the sequence):
|
|
|
For example, the following query results in 3 records from ~/fred_domains~ to be returned, starting from record \#1 (second in the sequence):
|
|
|
|
|
|
#+begin_example
|
|
|
GET /fred_domains?limits=3&offset=1 HTTP/1.1
|
... | ... | @@ -74,6 +74,6 @@ It is also possible to select returned record members that correspond to columns |
|
|
|
|
|
PostgREST also generates a description of the REST API using the [[https://swagger.io/specification][OpenAPI]] language. It is served from the [[https://stats.adam.nic.cz][root endpoint]].
|
|
|
|
|
|
A more attractive representation of the OpenAPI specification is the so-called Swagger UI, available from https://stats.adam.nic.cz/swagger. This web interface lists all available endpoints and available query parameters.
|
|
|
A more attractive representation of the OpenAPI specification is the so-called Swagger UI, available from https://stats.adam.nic.cz/swagger. This web interface lists all available endpoints and corresponding query parameters.
|
|
|
|
|
|
REST API queries can also be executed directly from the Swagger UI. To do so, click on an endpoint and then on the *Try it out*. After specifying parameters in the web form, the query can be run using the *Execute* bar. To avoid excessively long responses, it is recommended to set at least the ~limit~ parameter to a reasonable number. |