From 038f5798ad777b4e78da839c31947fdff5c2e061 Mon Sep 17 00:00:00 2001 From: Malin1601 Date: Mon, 12 May 2025 13:21:20 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ae60d7c..6634e37 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,8 @@ This project provides a REST API built using FastAPI. It handles fire risk predi - Defines the following endpoints: - `/`: Lists all available API routes. - `/api/{location}`: Fetches fire risk predictions for a specific location. + - **Query Parameters** + - `weatherdata` (optional): Include weather data in the response (default: `false`). - `/api/{location}/trends`: Provides fire risk trends for a specific location. - `/public`: A public endpoint with general information about the API. - Implements role-based access control using authentication mechanisms. From b280449d12dc49dacad89e68e7c2071e14ac1290 Mon Sep 17 00:00:00 2001 From: Malin1601 Date: Mon, 12 May 2025 14:02:08 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6634e37..b17a625 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# Table of contents + - [Introduction](#introduction) @@ -74,12 +76,6 @@ The token does have a timeout, and you will have to get a new token each time th Remember ! To access your login-priviliges you have to use localhost:8080, but when you want to access the api you have to use localhost:8000 -Possible URL's that available for this api at this point in time: -localhost:8000/ -localhost:8000/public -localhost:8000/api -localhost:8000/api/{location} -localhost:8000/api/{location}/trends ### Messaging service To run the messaging service locally you can do the following: @@ -87,7 +83,8 @@ To run the messaging service locally you can do the following: 2. In the .env file, fill in the connection values from HiveMQ under "Connection Details" 3. Make a credential in HiveMQ under "Access Management" and fill these values in the .env file. 4. Run the Fire risk API -5. Go into terminal and run the publisher with command "python publisher.py" +5. Go into terminal and run the publisher with command `python .\API\messaging\publisher.py` + You can now go into the Web Client in HiveMQ ![Alt text](images/ConnectHiveMQ.png)