Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.57 KB

README.md

File metadata and controls

39 lines (29 loc) · 1.57 KB
Raw

Koop Provider for the UN SDG Project

This Koop (https://github.com/koopjs/koop) provider is designed for use with the UN SDG API (https://unstats.un.org/SDGAPI/swagger/#/) as the attribute base. The geometry is merged with data from a Hosted Feature service in ArcGIS Online. This verision of the Koop connector supports the Quantization Paramaters to serve the geometry based on scale for high performance.

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 sample 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
  • npm start

Example API Query:

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

Tests:

  • npm test

With Docker

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

Publish to npm

  • run npm init and update the fields
    • Choose a name like koop-provider-foo
  • run npm publish