Skip to content

Latest commit

 

History

History
71 lines (39 loc) · 3.19 KB

README.md

File metadata and controls

71 lines (39 loc) · 3.19 KB
Raw

ExCELL Geocoding Service

The Geocoding API provides two endpoints (wrapper for the well-known OpenStreetMap geocoder Nominatim or Photon) to transform text-based addresses into GPS coordinates and vice versa. Geocoding is necessary e.g. for converting a client address into a routing destination.

Setup

This web service comes as a SpringBoot application so it's very easy to test it on your local machine. If you run the service from inside a Java IDE a Tomcat server will be launched and you can access the service through a browser via localhost:34343.

Application properties

The URLs for both the Nominatim and Photon endpoints can be changed in the application.properties in case you want to use another host.

Build it

The project is using Maven as a build tool and for managing the software dependencies. So in order to build the software you should install Maven on your machine. To create an executable JAR file for your local machine open you favourite shell environment and run:

mvn clean package

This creates a JAR file called geocoding-0.0.1-SNAPSHOT.jar. You can change the name in the pom.xml file.

Run it

On your local machine run the JAR with:

java -jar geocoding-0.0.1-SNAPSHOT.jar

On a remote machine use it is necessary to specify the location of the OSM file and routing graph directory. You might also want to change the server port

java -jar geocoding-0.0.1-SNAPSHOT.jar --server.port=44444

API Doc

This projects provides a Swagger interface to support the Open API initiative. The Java library Springfox is used to automatically create the swagger UI configuration from annotations in the Java Spring code.

An online version of the scheduling API is available on the ExCELL Developer Portal: Try it out!. You need to sign up first in order to access the services from the portal. Every user receives a token that he/she has to use for authorization for each service.

Developers

  • Felix Kunde (BHS)
  • Stephan Pieper (BHS)
  • Oguzhan Uyar (BHS)
  • Maximilian Allies (BHS)

Contact

  • fkunde [at] beuth-hochschule.de

Acknowledgement

The Geocoding Service has been realized within the ExCELL project funded by the Federal Ministry for Economic Affairs and Energy (BMWi) and German Aerospace Center (DLR) - agreement 01MD15001B.

Special Thanks

  • Dev Team behind Nominatim
  • Dev Team behind Photon (Komoot, Graphhopper etc.)

Disclaimer

THIS SOFTWARE IS PROVIDED "AS IS" AND "WITH ALL FAULTS." BHS MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE QUALITY, SAFETY OR SUITABILITY OF THE SKRIPTS, EITHER EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

IN NO EVENT WILL BHS BE LIABLE FOR ANY INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES HOWEVER THEY MAY ARISE AND EVEN IF BHS HAS BEEN PREVIOUSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.