Skip to content
GeoJSON provider for Koop
JavaScript Dockerfile Shell
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.dockerignore
.gitignore
.travis.yml
Dockerfile
LICENSE
README.md
controller.js
create.sh
index.js
lambda.js
model.js
package.json
routes.js
server.js
update.sh

README.md

Build Status Greenkeeper badge

Koop geojson Provider

This is a geojson that demonstrates how to build a Koop Provider. Full documentation is provided here.

/geojson/{url|pipe|path}/FeatureServer/0/query

where the URL changes / to | for including in the url. e.g.

example.com%7Cshares%7C6de6fe4ccdea85b8.geojson

To try this out, here are few example services:

If you want to write your own provider, simply fork this repository or copy the contents.

Files

File Description
index.js Mandatory Configures provider for usage by Koop
model.js Mandatory Translates remote API to GeoJSON
routes.js Optional Specifies additional routes to be handled by this provider
controller.js Optional Handles additional routes specified in routes.js
server.js Optional Reference implementation for the provider
test/model-test.js Optional tests the getData function on the model
test/fixtures/input.json Optional a geojson of the raw input from the 3rd party API
config/default.json Optional used for advanced configuration, usually API keys.

Test it out

Run server:

  • npm install
  • DEPLOY=dev node server.js

Example API Query:

  • curl localhost:8080/geojson/FeatureServer/0/query?returnCountOnly=true

Tests:

  • npm test

With Docker

  • docker build -t koop-provider-geojson .
  • docker run -it -p 8080:8080 koop-provider-geojson

Publish to npm

  • run npm init and update the fields
    • Choose a name like koop-provider-foo
  • run npm publish
You can’t perform that action at this time.