graphdbhue3/README.md

29 lines
901 B
Markdown

# Graph Databases Homework 3
A simple route planning between cities with routes was implemented in Rust.
## Run yourself
The project has a minimum supported Rust version (MSRV) of 1.63.0.
The Neo4j database has to be started on localhost on port 7687.
If you want a different port change it in `main.rs`
To start the project run:
`cargo run --package graphdbhue3 --bin graphdbhue3`
## Accessing Web Interface
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.