You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
10
10
The ohsome API is a generic web API for in-depth analysis of OpenStreetMap (OSM) data with a focus on it's history. It allows to get aggregated statistics about the evolution of OSM data itself and about the contributors behind the data. Furthermore, data extraction methods are provided to access the historic development of individual OSM features.
11
11
12
-
The functionalities of the ohsome API can be accessed via HTTP requests. As a basis underneath serves the [OSHDB API](https://github.com/GIScience/oshdb). The current stable version is [v1.0.0](https://github.com/GIScience/ohsome-api/releases/tag/1.0.0). Developed and maintained by [HeiGIT](https://heigit.org/).
12
+
The functionalities of the ohsome API can be accessed via HTTP requests. As a basis underneath serves the [OSHDB API](https://github.com/GIScience/oshdb). The current stable version is [v1.1.0](https://github.com/GIScience/ohsome-api/releases/tag/1.1.0). Developed and maintained by [HeiGIT](https://heigit.org/).
13
13
14
14
## Using the ohsome API
15
15
@@ -37,8 +37,8 @@ These instructions will get you a copy of the project up and running on your loc
37
37
2. move to your Maven project directory in a shell (e.g. Windows PowerShell)
38
38
3. enter the command `mvn -DskipTests=true package` to build the project (if you want to build it running the integrated tests too, look at the section [Testing](#testing))
39
39
4. to run the jar file enter the following (if no additional keytables file is given, you can assume that it is included):
* keytables not included: `java -jar target/ohsome-api-1.1.0.jar --database.db=C:/path-to-your-data/ba-wue.oshdb --database.keytables=C:/path-to-your-keytablesFile/keytables`
42
42
43
43
Now you should have a running local API, which is ready for receiving requests under *http://localhost:8080/*.
44
44
<br>To check if it is running properly, you should be able to visit the swagger documentation under *http://localhost:8080/swagger-ui.html*.
@@ -49,7 +49,7 @@ Now you should have a running local API, which is ready for receiving requests u
49
49
* to enable in-memory-caching: `--database.caching=true` (caution.. enabling this option requires quite some memory, but makes processing much faster)
50
50
* if you want to run the maven project in your IDE, you need to set the paths to your data in the run configurations
51
51
* in Eclipse: *Run As --> Run Configurations --> (x)= Arguments --> Program arguments: 'enter the parameters here'*
52
-
* if you want to get information about the code directly, you can access the [Javadoc](https://docs.ohsome.org/java/ohsome-api/1.0.0/), which gets updated daily.
52
+
* if you want to get information about the code directly, you can access the [Javadoc](https://docs.ohsome.org/java/ohsome-api/1.1.0/), which gets updated daily.
53
53
54
54
## Testing
55
55
@@ -96,7 +96,7 @@ Here you see an example response giving the length of residential roads for a bo
0 commit comments