https://github.com/khachatur/flightpathtracker
The Flight Path Tracker API is a microservice designed to help track and understand flight paths based on provided flight records.
https://github.com/khachatur/flightpathtracker
api azure cqrs csharp flight-tracking graph mediatr microservice unit-testing
Last synced: about 1 year ago
JSON representation
The Flight Path Tracker API is a microservice designed to help track and understand flight paths based on provided flight records.
- Host: GitHub
- URL: https://github.com/khachatur/flightpathtracker
- Owner: khachatur
- Created: 2024-10-28T12:26:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-28T13:25:17.000Z (over 1 year ago)
- Last Synced: 2025-04-05T23:42:30.714Z (about 1 year ago)
- Topics: api, azure, cqrs, csharp, flight-tracking, graph, mediatr, microservice, unit-testing
- Language: C#
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flight Path Tracker API
## Overview
The **Flight Path Tracker API** is a microservice designed to help track and understand flight paths based on provided flight records.
Story: There are over 100,000 flights a day, with millions of people and cargo being transferred worldwide. With so many people and different carrier/agency groups, tracking where a person might be can be hard. To determine a person's flight path, we must sort through their flight records.
Goal: To create a simple microservice API to help us understand and track how a particular person's flight path may be queried. The API should accept a request that includes a list of flights defined by a source and destination airport code. These flights may not be listed in order and must be sorted to find the total flight paths starting and ending at airports.
Required JSON structure:
- [["SFO", "EWR"]] => ["SFO", "EWR"]
- [["ATL", "EWR"], ["SFO", "ATL"]] => ["SFO", "EWR"]
- [["IND", "EWR"], ["SFO", "ATL"], ["GSO", "IND"], ["ATL", "GSO"]] => ["SFO", "EWR"]
## Specifications
- **Port**: The microservice listens on **port 8080**.
- **Endpoint**: The API exposes the flight path tracker under the `/calculate` endpoint.
## Installation
### Prerequisites
- .NET SDK (version 8.0 or later)
### Steps to Run the Project
1. Clone the repository:
```bash
git clone https://github.com/khachatur/FlightPathTracker.git
cd FlightPathTracker
```
2. Restore dependencies:
```bash
dotnet restore
```
3. Run the application:
```bash
dotnet run --project src/FlightPathTracker.Api
```
4. The API will be accessible at http://localhost:8080.
## API Endpoint
### POST /calculate
### Request Body
JSON array of flights:
```json
{
"flights": [
["ATL", "EWR"],
["SFO", "ATL"]
]
}
```
### Response
- JSON array representing the calculated flight path.
Response body
```json
["SFO", "EWR"]
```
### Testing
You can test the API using Swagger UI or tools like Postman or curl.
### Conclusion
The API provides an efficient way to track flight paths based on airport codes.