User Microservice API

This is the API documentation for the User Microservice. This service allows users to register, log in, retrieve user details, and manage user account balances. The API uses JWT-based authentication for secure access to certain endpoints.

Installation

Clone the repository:

git clone https://github.com/smammahdi/hackfleet.git

Navigate to the project directory:
```
cd user-microservice
```
Build the project using Maven:
```
mvn clean install
```
Run the application:
```
mvn spring-boot:run
```

The application should now be running locally on http://20.115.178.62.

API Endpoints

1. Register a New User

Endpoint: POST /users/register

Request Body:

{
  "nid": "long",
  "name": "string",
  "email": "string",
  "password": "string",
  "money": "long"
}

Response:

Body:
```
{
  "token": "string"
}
```
Status Code: 200 OK

2. User Login

Endpoint: POST /users/login

Request Body:

{
  "email": "string",
  "password": "string"
}

Response:

Body:
```
{
  "token": "string"
}
```
Status Code: 200 OK

3. Get User by ID

Endpoint: GET /users/{id}

Path Variable:

id: User's ID (Long)

Response:

Body:

{
  "id": "long",
  "nid": "long",
  "name": "string",
  "email": "string",
  "money": "long"
}

Status Code: 200 OK

4. Add Balance to User's Account

Endpoint: PUT /users/balance/add

Request Parameters:

userId: User's ID (Long)
balance: Amount to add to the user's balance (Long)

Response:

Body: "Balance updated successfully"
Status Code: 200 OK

5. Reduce Balance from User's Account

Endpoint: PUT /users/balance/reduce

Request Parameters:

userId: User's ID (Long)
balance: Amount to reduce from the user's balance (Long)

Response:

Body: "Balance updated successfully"
Status Code: 200 OK

Authorization

For endpoints like Get User by ID, Add Balance, and Reduce Balance, you need to provide the JWT token in the request headers.

Header Example:

Authorization: Bearer <token>

Replace <token> with the actual token you received upon registration or login.

Trains Microservice API

This documentation provides an overview of the Trains Microservice. This service allows users to search for trains, view seats, manage train data, and update seat statuses.

API Endpoints

1. Get Trains by From, To, and Date

Endpoint: GET /trains

Description:

Retrieve a list of trains based on the departure location, destination, and date.

Request Body:

{
  "fromPlace": "string",
  "toPlace": "string",
  "departureDate": "yyyy-MM-dd"
}

Response:

Body:

[
  {
    "id": "long",
    "name": "string",
    "fromPlace": "string",
    "toPlace": "string",
    "departureTime": "yyyy-MM-ddTHH:mm:ss",
    "seats": [...]
  }
]

Status Code: 200 OK

2. Get Seats by Train ID

Endpoint: GET /trains/{trainId}/seats

Description:

Retrieve a list of seats for a specific train. You can optionally filter the seats by class.

Path Variable:

trainId: The ID of the train.

Request Parameters:

seatClass (optional): The class of the seats (e.g., "Economy", "Business").

Response:

Body:

[
  {
    "seatId": "long",
    "seatClass": "string",
    "status": "string",
    "price": "long"
  }
]

Status Code: 200 OK

3. Add New Trains with Seats

Endpoint: POST /trains/add

Description:

Add new trains with their associated seats. You can add multiple trains at once.

Request Body:

[
  {
    "name": "string",
    "fromPlace": "string",
    "toPlace": "string",
    "departureTime": "yyyy-MM-ddTHH:mm:ss",
    "seats": [
      {
        "seatClass": "string",
        "status": "string",
        "price": "long"
      }
    ]
  }
]

Response:

Body:

[
  {
    "id": "long",
    "name": "string",
    "fromPlace": "string",
    "toPlace": "string",
    "departureTime": "yyyy-MM-ddTHH:mm:ss",
    "seats": [...]
  }
]

Status Code: 200 OK

4. Get All Trains with Seats

Endpoint: GET /trains/with-seats

Description:

Retrieve all trains along with their seats.

Response:

Body:

[
  {
    "trainId": "long",
    "trainName": "string",
    "fromPlace": "string",
    "toPlace": "string",
    "departureTime": "yyyy-MM-ddTHH:mm:ss",
    "seats": [...]
  }
]

Status Code: 200 OK

5. Set Seat Status and Calculate Total Cost

Endpoint: PUT /trains/setStatus

Description:

Set the status of one or more seats and calculate the total cost of the seats with the specified status.

Request Body:

{
  "seatIds": ["long", "long"],
  "status": "string"
}

Response:

Body:
```
{
  "totalCost": "long"
}
```
Status Code: 200 OK

Authorization

Currently, the Trains Microservice API does not require authentication for accessing its endpoints. All endpoints are publicly accessible.

Payment Microservice API

This documentation provides an overview of the Payment Microservice. The service is responsible for handling payment creation, retrieving tickets associated with a user, and managing ticket deletion.

Installation

Clone the repository:

git clone https://github.com/your-repository/payment-microservice.git

Navigate to the project directory:
```
cd payment-microservice
```
Build the project using Maven:
```
mvn clean install
```
Run the application:
```
mvn spring-boot:run
```

The application will run locally at http://localhost:8080.

API Endpoints

1. Create Payment

Endpoint: POST /payment

Description:

This endpoint allows the creation of a payment for a user by specifying user ID, booking ID, and a list of passengers. Upon successful creation, the payment details are returned.

Request Body:

{
  "userId": "long",
  "bookingId": "long",
  "passengerList": ["string"]
}

Response:

Body:

{
  "paymentId": "long",
  "userId": "long",
  "bookingId": "long",
  "amount": "long"
}

Status Code: 201 Created

Error Response:

Body: "Error message"
Status Code: 400 Bad Request

2. Get Tickets by User

Endpoint: GET /payment/ticket

Description:

Retrieve a list of tickets associated with a specific user by providing their user ID.

Request Body:

{
  "userId": "long"
}

Response:

Body:

[
  {
    "ticketId": "long",
    "userId": "long",
    "passengerList": ["string", "string"],
    "seatId": ["long"],
    "amount": "long",
    "bookingId": "long",
    "paymentId": "long"
  }
]

Status Code: 200 OK

Error Response:

Status Code: 404 Not Found

3. Get Ticket by ID for a User

Endpoint: GET /payment/ticket/{ticketId}

Description:

Retrieve a specific ticket by its ID and the user associated with it. You must provide the user ID in the request body and the ticket ID in the path variable.

Path Variable:

ticketId: Ticket's ID (Long)

Request Body:

{
  "userId": "long"
}

Response:

Body:

{
  "ticketId": "long",
  "userId": "long",
  "passengerList": ["string"],
  "seatId": ["long"],
  "amount": "long",
  "bookingId": "long",
  "paymentId": "long"
}

Status Code: 200 OK

Error Response:

Status Code: 404 Not Found

4. Delete Ticket by ID

Endpoint: DELETE /payment/ticket/{ticketId}

Description:

Delete a specific ticket by providing the user ID and the ticket ID.

Path Variable:

ticketId: Ticket's ID (Long)

Request Body:

{
  "userId": "long"
}

Response:

Body: "Ticket deletion was successful"
Status Code: 200 OK

Error Response:

Status Code: 404 Not Found

Authorization

Currently, the Payment Microservice API does not require authentication for accessing its endpoints. All endpoints are publicly accessible.

Booking Microservice API

This documentation provides an overview of the Booking Microservice. The service is responsible for managing user bookings, verifying bookings using OTP, and retrieving booking details.

API Endpoints

1. Add Booking

Endpoint: POST /booking

Description:

This endpoint allows a user to create a booking by providing their user ID and a list of seat IDs. Upon successful booking, the booking ID is returned.

Request Body:

{
  "userId": "long",
  "seatIds": ["long"]
}

Response:

Body:
```
{
  "bookingId": "long"
}
```
Status Code: 202 Accepted

Error Response:

Body: "Booking wasn't successful!"
Status Code: 404 Not Found

2. Verify Booking with OTP

Endpoint: POST /booking/verify

Description:

This endpoint allows the user to verify their booking by providing the OTP (One-Time Password) sent to their registered contact details. If the OTP is correct, the booking is confirmed.

Request Body:

{
  "userId": "long",
  "bookingId": "long",
  "otp": "long"
}

Response:

Body: true (if verified) or false (if verification failed)
Status Code: 202 Accepted

3. Get Booking by ID

Endpoint: GET /booking/{id}

Description:

Retrieve the details of a booking using its booking ID.

Path Variable:

id: The ID of the booking.

Response:

Body:

{
  "bookingId": "long",
  "userId": "long",
  "seatIds": ["long"],
  "status": "string"
}

Status Code: 200 OK

Error Response:

Status Code: 404 Not Found

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
.vscode		.vscode
azure-configs.yaml		azure-configs.yaml
bookingms		bookingms
frontend		frontend
paymentms		paymentms
trainms		trainms
userms		userms
.DS_Store		.DS_Store
docker-compose.yaml		docker-compose.yaml
readme.md		readme.md

Latest commit

History

Folders and files

Repository files navigation

User Microservice API

Table of Contents

Installation

API Endpoints

1. Register a New User

Request Body:

Response:

2. User Login

Request Body:

Response:

3. Get User by ID

Path Variable:

Response:

4. Add Balance to User's Account

Request Parameters:

Response:

5. Reduce Balance from User's Account

Request Parameters:

Response:

Authorization

Header Example:

Trains Microservice API

Table of Contents

API Endpoints

1. Get Trains by From, To, and Date

Description:

Request Body:

Response:

2. Get Seats by Train ID

Description:

Path Variable:

Request Parameters:

Response:

3. Add New Trains with Seats

Description:

Request Body:

Response:

4. Get All Trains with Seats

Description:

Response:

5. Set Seat Status and Calculate Total Cost

Description:

Request Body:

Response:

Authorization

Payment Microservice API

Table of Contents

Installation

API Endpoints

1. Create Payment

Description:

Request Body:

Response:

Error Response:

2. Get Tickets by User

Description:

Request Body:

Response:

Error Response:

3. Get Ticket by ID for a User

Description:

Path Variable:

Request Body:

Response:

Error Response:

4. Delete Ticket by ID

Description:

Path Variable:

Request Body:

Response:

Error Response:

Authorization

Booking Microservice API

Table of Contents

API Endpoints

1. Add Booking