pg_featureserv

pg_featureserv

A lightweight RESTful geospatial feature server for PostGIS, written in Go. It supports the OGC API - Features REST API standard.

Features

• Implements the OGC API - Features standard.
  • Supports standard request parameters limit, bbox
  • Extended parameters include offset, properties, orderBy, transform, precision
• Data reponses are formatted in JSON and GeoJSON
• Provides a simple HTML user interface, with web maps to view spatial data
• Uses the power of PostgreSQL to reduce the amount of code and to make data definition easy and familiar.
  • Feature collections are defined by database objects (tables and views)
• Uses PostGIS to provide geospatial functionality:
  • Transforming geometry data into the output coordinate system
  • Marshalling feature data into GeoJSON
• Full-featured HTTP support
  • CORS support with configurable Allowed Origins
  • GZIP response encoding

Download

Builds of the latest code:

• Linux
• Windows
• OSX
• Docker

Building from Source

pg_featurserv is developed under Go 1.13. It may also work with earlier versions.

• Ensure the Go compiler is installed
• Download or clone this repository into $GOPATH/src/github.com/CrunchyData/pg_featureserv
• To build the executable, run the following commands:

cd $GOPATH/src/github.com/CrunchyData/pg_featureserv/
go build

• This should create a pg_featureserv executable in the application directory

Configuring the service

• Set the environment variable DATABASE_URL with a Postgres connection string
  • Example: export DATABASE_URL="host=localhost"
• Edit the configuration file config.toml, located in the application directory

Running the service

• If not already done, move to the application directory:
  • cd $GOPATH/src/github.com/CrunchyData/pg_featureserv
• Start the server:
  • ./pg_featureserv
• Open the service home page in a browser:
  • http:/localhost:9000/home.html

Command-line options

• -? - show command usage
• --config file.toml - specify configuaration file to use
• --debug - set logging level to TRACE (can also be set in config file)
• --devel - run in development mode (e.g. HTML templates reloaded every query)
• --test - run in test mode, with an internal catalog of tables and data

Requests Overview

Features are identified by a collection name and feature id pair.

The default response is in JSON/GeoJSON format. Append .html to the request path to see the UI page for the resource.

The example requests assume that the service is running locally and configured to listen on port 9000.

• Landing page (HTML or JSON): http://localhost:9000/
• Landing page (HTML): http://localhost:9000/index,html
• Landing page (JSON): http://localhost:9000/index.json
• OpenAPI definition: http://localhost:9000/api
• OpenAPI test UI: http://localhost:9000/api.html
• Conformance: http://localhost:9000/conformance
• Collections JSON: http://localhost:9000/collections
• Collections UI: http://localhost:9000/collections.html
• Feature collection metadata: http://localhost:9000/collections/{name}
• Feature collection UI: http://localhost:9000/collections/{name}.html
• Features from a single feature collection: http://localhost:9000/collections/{name}/items
• Features from a single feature collection (Map UI): http://localhost:9000/collections/{name}/items.html
• Single feature from a feature collection: http://localhost:9000/collections/{name}/items/{featureid}
• Functions (JSON): http://localhost:9000/functions
• Functions UI: http://localhost:9000/functions.html
• Function metadata: http://localhost:9000/functions/{name}
• Function UI: http://localhost:9000/functions/{name}.html
• Features from a function (JSON): http://localhost:9000/functions/{name}/items
• Features from a function (Map UI): http://localhost:9000/functions/{name}/items.html

See API Summary for a summary of the API.