Koop provides a flexible server for exposing 3rd party data sources (APIs) as both Feature Services and other data formats (GeoJSON). This project is meant to provide a simple / plugable platform for experimenting with various data within the ArcGIS platform. Koop aims to provide a platform for accessing any API and making it easy to consume within the realm of Esri's geospatial web products.
Visit the demo at http://koop.dc.esri.com
The following dependencies are needed in order to run Koop on your local machine / server:
- Node.js (version > 0.10.0)
- Database
- Koop needs a spatial database to act as a cache for data
- Currently supports PostGIS (PostgreSQL) and Spatialite (SQLite)
- clone the repo
git clone git@github.com:Esri/koop.git - enter the koop project directory
cd koop - install the node.js dependencies
npm install
Koop uses a series of config files in the /config directory to setup its database connection and data directories for caching data.
NOTE: it is crucial that you make the appropriate edits to your config/default.yml file so that the values match your environment.
- copy the example config file
cp config/default.yml.example config/default.yml - edit config/default.yml for your environment.
In particular you will need to:
- Ensure that the specified logfile directory exists and you have write permissions on it.
- Ensure that the PostGIS database configuration matches the host, port, user, password, and name of your database.
- For Github and Gist providers you will need to set the
github_tokenproperty to match your personal Github API token.
Koop uses either a local SQLite cache or a PostgreSQL/PostGIS database to store data so that it doesnt flood external API with requests. This is helpful to prevent API rate limits and general makes Koop faster (quick access to data). The local SQLite file should not be used for production as it has limits on scale and across processes and in production use you should use a PostgreSQL database.
Koop runs its own HTTP server and will default to port 1337.
node server.js
PORT=8080 node server.js
Koop is designed to expose 3rd party services as FeatureServices that are consumable within Esri products and services. Currently Koop has the following providers shipped by default:
Each provider resides in its own git repo (e.g. koop-github)
To install a provider all you need to do is:
npm install https://github.com/chelm/koop-github/tarball/master
To modify the koop-server or develop new koop providers you install them to the node_modules directory in the koop application folder:
- check out
koop-serverand link in node_modules
git clone git@github.com:Esri/koop-server.git
cd koop-server && npm install
cd node_modules && ln -s ../koop-server
- check out providers such as
koop-agoland link in node_modules
git clone git@github.com:Esri/koop-agol.git
cd koop-agol && npm install
cd node_modules && ln -s ../koop-agol
Each provider defines custom routes, a controller, and a model. Each of these uses module.exports to export an object (common js modules). Each is then fused into koop at start up time and becomes available within the server.
"Note": The name of the provider dir is used to define the name of the provider and its controller within koop.
- Define custom routes in the "routes" index.js file:
// defined in api/providers/sample/routes/index.js
module.exports = {
'get /sample': {
controller: 'sample',
action: 'index'
}
}- The above creates a
/sampleroute that calls theindexmethod on the sample controller ( defined in/api/providers/sample/controller/index.js).
- Defines the handlers to used to respond to routes
module.exports = {
// this tells koop to treat this provider like AGS service and show up at the root data provider endpoint
provider: false,
// our index method to simple print text
index: function(req, res){
res.send('Sample Providers, to make this a real one set provider true');
}
}; - each method takes in a request and response property and needs to send something to the reponse.
- Should be used to interact directly with 3rd party services and databases
- Models make the http requests to API and should hand back raw data to the controllers
- http://koop.dc.esri.com/gist/6021269
- http://koop.dc.esri.com/gist/6021269/FeatureServer
- http://koop.dc.esri.com/gist/6021269/FeatureServer/0
- http://koop.dc.esri.com/gist/6021269/FeatureServer/0/query
- http://koop.dc.esri.com/github/colemanm/hurricanes/fl_2004_hurricanes
- http://koop.dc.esri.com/github/colemanm/hurricanes/fl_2004_hurricanes/FeatureServer
- http://koop.dc.esri.com/github/colemanm/hurricanes/fl_2004_hurricanes/FeatureServer/0/query
- Note: Repos can of course have directories, and this presents an issue with creating dynamic routes that match arbitrary paths in github. To solve this Koop will replace dashes with slashed in its github routes:
- http://koop.dc.esri.com/github/geobabbler/geodata/geojson-border_crossings/FeatureServer/0/query
- The above url would pull down this geojson file: https://github.com/geobabbler/geodata/blob/master/geojson/border_crossings.geojson
Not all capabilities of FeatureServices are currently supported. It is planned to extend support for these as well as explore additional output formats.
Issues
5CA5Find a bug or want to request a new feature? Please let us know by submitting an issue.
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
Copyright 2014 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's license.txt file.
[](Esri Tags: ArcGIS Web Mapping GeoJson FeatureServices) [](Esri Language: JavaScript)