Home

Welcome to the node-gis-server wiki!

Conventions

In the application core (core.js), resources will generally follow a noun-verb convention. Resource paths shall traverse nouns in a descending level of granularity with any verb (optional), indicative of a processing action, to be at the end of the resource path. A resource path need not have a verb but, if it does, it should only contain one. Consider the following paths:

noun-only:
/vector/:schema/:table/:geom
noun-verb:
/vector/:schema/:table/:geom/:operation

This path is currently represented in the core as the resource path to fetch the GeoJSON representation of a table. An example path would be:

/vector/public/parcels/features

Note that the path starts with the very general (vector) and proceeds to the specific (features). Now consider the following example that ends in a verb:

/vector/

The application core will apply this convention to the greatest extent possible. While it is not necessary for custom extensions to follow this convent