About the project

This is the Backend (Java) Developer Case Assignment within the Future Talent Program of Amadeus & Coderspace.

Author: nikben08

Docker Installation

1. Clone the repository:

   git clone https://github.com/nikben08/amadeus-flight-api.git

2. Navigate to the root directory:

   cd amadeus-flight-api

3. Run container:

   docker-compose up

Check out the Swagger API documentation 📦

You need to run the project on your local environment first.

localhost:8080/swagger-ui/index.html

Prepare your PostgreSQL server and then seed your airports and flights using the /api/v1/jobs/trigger [POST] endpoint!

You can also find the Postman documentation here!

Run in Postman 🚀

You will need to set up Basic Authentication in Postman before executing any requests. To do this, you should create an API user with appropriate credentials.

How to use?

Description

This API provides access to comprehensive flight data based on given parameters. It allows users to search for flights between specified departure and arrival airports on a given departure date. Optionally, users can also retrieve return flights for the same airports by providing a return date.

Search Endpoint

/api/v1/flights/search

Method

GET

Request Parameters

1. departureAirportId (required)

   • Type: Integer
   • Description: The unique identifier of the departure airport.
   • Example: 1

2. arrivalAirportId (required)

   • Type: Integer
   • Description: The unique identifier of the arrival airport.
   • Example: 2

3. departureDate (required)

   • Type: String (ISO 8601 Date Format: "YYYY-MM-DD")
   • Description: The departure date for the outbound flight.
   • Example: "2024-02-20"

4. returnDate (optional)

   • Type: String (ISO 8601 Date Format: "YYYY-MM-DD")
   • Description: The return date for the inbound flight. If provided, it fetches return flights with the same airports.
   • Example: "2024-02-20"