geojson-api

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #llm #golang #android #machine-learning #rust #deep-learning #nodejs #ios #mcp #open-source

(★ 18)

RESTful API for GeoJSON data.

geojson-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GeoJSON API

In general, the (beta) geojson-api was developed for a project that assesses [OpenStreetMap (OSM)](openstreetmap.org) city-level building data. That said, the following documentation is to show how you can work with GeoJSONs with open sourced tools as an alternative to proprietary software; in addition, to show how to store and handle large spatially-referenced data, and how to access the data through an API to repurpose the data however you please.

In my case, I used the API to output the GeoJSONs onto a Mapbox GL JS map that shows all the buildings based on a client selecting the city. I used data-driven styling for the buildings (e.g., color buildings based on the building type attribute). Mapbox GL JS is great because it has built in functions to handle large GeoJSON files. With Mapbox GL JS, all buildings for Ottawa and Gatineau, Canada, can be projected and rendered onto a map seamlessly.

Most of this work was accomplished through reading various sources and combining them together.

# General Infastructure

This app uses a [Node](nodejs.org/en/) and [Express](expressjs.com) based RESTful API that uses [pg-promise](github.com/vitaly-t/pg-promise) to pull the data from the database. The pg-promise library is "built on top of [node-postgres](github.com/brianc/node-postgres)," which incorporates pooling for database querying. This will avoid choking the app if there are several queries, especially if there are several queries that are pulling large amounts of data.

The following documentation highlights how to prepare your GeoJSON data into a PostgreSQL/PostGIS database, how to connect a Node app's server to the local PostgreSQL database, how data is queried in the GitHub code, and how to use the API to access the data.

# Quick Steps

1. Download spatial data (or use test GeoJSON files in the data folder)
2. Store the GeoJSON data in a [PostgreSQL](www.postgresql.org) and [PostGIS](postgis.net) enabled database using [GDAL's ogr2ogr](www.gdal.org/ogr2ogr.html)
3. Modify `var connectionString` in server.js to accomodate your database credentials
4. Lastly, follow steps under 'Deploy API / App'

# Getting Started

As my environment is Windows, the following instructions following this environment.

## Prerequisites

The following should be installed locally to manage the database: [OSGeo4W (or just install GDAL)](trac.osgeo.org/osgeo4w/) (make sure the PostgreSQL driver is installed as well), [PostgreSQL 9.6](postgresql.org.download/), [pgAdmin4 v1](pgadmin.org/download/pgadmin-4-windows/) and [PostGIS 2.3.2](postgis.net/install/).

## Data Management

First you will need to get your GeoJSON data. There are several ways to accomplish this. From example, OpenStreetMap (OSM) data. This open spatial data can be downloaded from [Geofabrik](www.geofabrik.de/data/download.html) and converted into a geojson, but [Mapzen](https://mapzen.com/data/metro-extracts/) has OSM data in geoJSON format available for download as well.

I am used to handling most spatial data from the client/browser using JavaScript; but, with such a large geojson (239.509 MB for Ottawa and 78.332 for Gatineau), a database and server were developed. To accomplish this, I first created a PostgreSQL database with a PostGIS extension. This can be done through [pgAdmin4](pgadmin.org/docs/pgadmin4/1.x/). Take note of the following database credentials: database name, user, and password. These credentials will be necessary to connect your server to the database.

To import a GeoJSON file into a new table in the PostgreSQL database you just created, you will need to use GDAL's ogr2ogr. (Note: There are other methods to accomplish this.)

To use GDAL, if yor environment is Windows, add the GDAL folder path to your Control Panel > User Accounts > Change my environmental variables (e.g., C:\OSGeo4W64\share\gdal). Then, in the OSGeo4w Shell, go to the directory with the geojson data and then entered the following:

ogr2ogr -f "PostgreSQL" PG:"dbname=[enter db name] user=[enter user] password=[enter password]" "[geojson file name]" -nln [table name] -append

*Text in [ ] indicates the info you will need to enter*

This line uses ogr2ogr to store a GeoJSON file into a specific table from a specific PostgreSQL/PostGIS database.

After running this line, go to pgAdmin4, your database should now have a new table with all the GeoJSON data in it. The geometry is stored as a wkb_geometry column with the 4326 (WGS84) projected coordinate system. In my case, it was one of the last columns in the database.

## API Installation

Now that your database exists with GeoJSON data, you can develop a server and web app that queries and visualizes the data. The server.js code creates the server, but queries.js connects and queries the database to the Node and Express based server. There is one key line you will have to change in queries.js to make the server access your local database:

var connectionString = process.env.DATABASE_URL || 'postgres://[user name]:[password]:[port]/[database name]';

The process.env.DATABASE_URL is there just in case you want to use Heroku to store the database in the cloud.

The current query function (getData()) in queries.js pulls the wkb_geometry, the building type tag, the area, and the centroid from either table and then converts the query into a GeoJSON feature collection.

# Deploy API / App

With your local database and the code, in the command line go into the directory with the code and enter:
	
	npm install
	
Then:

npm start

Then in a browser type the following URL:

localhost:3000

The API should output the table's data as a GeoJSON feature collection of building polygons.

# Authors

Julia Conzon

geojson-api

geojson-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

geojson-api

geojson-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README