README

This API converts geometry information from and to various formats. Additionally, it can create centroid and bbox information.

If no SRS is given, lon/lat order for coordinates is assumed (input) and written (output).

The default port is 3000 and can be changed using the GEO_API_PORT environment variable.

The current base route is /v1.

Endpoints

GET /api-docs

Shows API specification and debugging tool.

GET /info

Returns general information on API use.

GET /version

Returns version information.

POST /convert

Converts a given geometry object from and to one of the supported formats. The request requires a correct content-type header for the payload type - otherwise a simple heuristic is used to deduce it. The export format has to be specified via the exportFormat query parameter.

Also supports calculation of the centroid or the bounding box of a given geometry, via the mode parameter.

Content-Type

Accepted content-types are:

• [application/xml, application/gml+xml] for GML snippets
• [application/json, application/geo+json] for GeoJSON objects or arrays
• [text/plain] for WKT

Query Parameters

Required:

• exportFormat - One of [geojson, gml, wkt]

Optional:

• importCRS - Name of the reference system of the input geometry. Defaults to WGS84
• exportCRS - Name of the reference system of the output geometry. Defaults to WGS84
• mode - One of [full, centroid, bbox]. Defaults to full

Body

The to-be-converted geometry object in one of the supported formats.

Example GeoJSON:

{
    "type": "GeometryCollection",
    "geometries": [
        {
            "type": "Point",
            "coordinates": [40, 10]
        },
        {
            "type": "LineString",
            "coordinates": [[10, 40], [20, 20], [10, 10]]
        },
        {
            "type": "Polygon",
            "coordinates": [[[40, 40], [20, 45], [45, 30], [40, 40]]]
        }
    ]
}

Example GML:

<gml:MultiGeometry>
    <gml:geometryMembers>
        <gml:Point>
            <gml:pos>40 10</gml:pos>
        </gml:Point>
        <gml:LineString>
            <gml:posList>10 40 20 20 10 10</gml:posList>
        </gml:LineString>
        <gml:Polygon>
            <gml:exterior>
                <gml:LinearRing>
                    <gml:posList>40 40 20 45 45 30 40 40</gml:posList>
                </gml:LinearRing>
            </gml:exterior>
        </gml:Polygon>
    </gml:geometryMembers>
</gml:MultiGeometry>

Example WKT:

GEOMETRYCOLLECTION (POINT (40 10),
LINESTRING (10 40, 20 20, 10 10),
POLYGON ((40 40, 20 45, 45 30, 40 40)))

Formats

Supported formats for input and output (parameter in parentheses) are

• GeoJSON (geojson)
• GML (gml)
• WKT (wkt)

Tests

The accompanying tests can be run using:

npm run test