lukas/graphdbhue3
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

aadd usage sec

Browse Source
This commit is contained in:
lukas-heilgenbrunner 2024-05-29 13:49:02 +02:00
parent 2713540b29
commit 90b2d89a81
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -15,4 +15,15 @@ To start the project run:
## Accessing Web Interface ## Accessing Web Interface
The API is exposed on Port `8081`. The API is exposed on Port `8081`.
Access it through the Swagger Web UI: [http://localhost:8081](http://localhost: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.