aadd usage sec
This commit is contained in:
parent
2713540b29
commit
90b2d89a81
11
README.md
11
README.md
@ -16,3 +16,14 @@ To start the project run:
|
||||
The API is exposed on Port `8081`.
|
||||
|
||||
Access it through the Swagger Web UI: [http://localhost:8081](http://localhost:8081)
|
||||
|
||||
## Usage
|
||||
|
||||
### Adding cities and routes
|
||||
|
||||
With the `/addcity` and `/addroute` endpoints you can add cities and link them together through routes.
|
||||
|
||||
### Requesting shortest path
|
||||
|
||||
Afterwards you can plan a route from one city to another with `/shortestpath`.
|
||||
This returns the shortest path between the two cities respecting the `distance` parameter of the ROAD edge.
|
Loading…
Reference in New Issue
Block a user