REST API for Online Cab Booking Application

We have create a REST API for online cab booking application which can be used to book by customers to login into their profile, update their information and book cabs, by a driver to login and update their details along with their cab details and accept a ride from the customer. All this is over looked by the admin who can also login and update their information as well as access the data in the application. We have implemented data and user validation at every step, for every user.

This is a collaborative project, completed by a team of 5 backend developers at Masai School.

Collaborators

Tech Stack

Java
Hibernate
Spring Framework
Spring Boot
Spring Data JPA
MySQL
Swagger UI
Maven

Modules

Login Module
Cab Driver Module
Customer Module
Admin Module
Trip Details Module

Features

Data Authentication and Validation for all the users (Admin, Customer and Cab Driver)

Admin Features

Admin can access all the information of customer, cab driver and cab.
Admin can access all Trip Details along with specific trip details using a particular cab or a customer.

Customer Features

Customer can login in the application and update their information using their username and password.
Customer can book trips using pickup location and destination.
Customer can access the bill after the trip is completed.

Cab Driver features

Cab Driver can login in the application and update their information using their username and password.
Cab driver can add and update their cab details.
Cab Driver can mark their availability according to the trips status.
Cab Driver can end the trip and application generates a bill for the trip.

Installation & Run

Before running the API server, you should update the database config inside the application.properties file.
Update the port number, username and password as per your local database configuration.

    server.port=8888

    spring.datasource.url=jdbc:mysql://localhost:3306/cabdb;
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.username=root
    spring.datasource.password=root

API Root Endpoint

https://localhost:8888/

http://localhost:8888/swagger-ui/

API Reference

Customer Requests

  Customer Controller

Request	METHOD	URI	Description
`POST`	`Create`	`http://localhost:8888/customer/create`	Create Customer
`PUT`	`Update`	`http://localhost:8888/customer/update`	Update Customer
`DELETE`	`Delete`	`http://localhost:8888/customer/delete`	Delete Customer
`POST`	`Book Trip`	`http://localhost:8888/customer/booktrip`	Book Trip
`DELETE`	`Cancel Trip`	`http://localhost:8888/customer/canceltrip`	Cancel Trip
`POST`	`Trip List`	`http://localhost:8888/customer/triplist`	Trip List
`POST`	`Generate Bill`	`http://localhost:8888/customer/generatebill`	Generate Bill

Cab Driver Requests

  Cab Driver Controller

Request	METHOD	URI	Description
`POST`	`Create`	`http://localhost:8888/cabdriver/create`	Create Cab Driver
`PUT`	`Update`	`http://localhost:8888/cabdriver/update`	Update Cab Driver
`DELETE`	`Delete`	`http://localhost:8888/cabdriver/delete`	Delete Cab Driver
`POST`	`Book Trip`	`http://localhost:8888/cabdriver/tripcompleted`	Trip Completed

Admin Requests

  Admin Controller

Request	METHOD	URI	Description
`POST`	`Create`	`http://localhost:8888/admin/create`	Create Admin
`PUT`	`Update`	`http://localhost:8888/admin/update`	Update Admin
`DELETE`	`Delete`	`http://localhost:8888/admin/delete`	Delete Admin
`POST`	`Get All Trip`	`http://localhost:8888/admin/getalltrips`	Show All Trip
`DELETE`	`Get Trip By Cab`	`http://localhost:8888/admin/getalltripsbycab/{cabId}`	Get All Trip By Cab ID
`POST`	`Get Trip By Customer`	`http://localhost:8888/admin/triplist`	Get All Trip By Customer

Sample API Response for Customer Account Creation

Request Type

POST

Request URI

http://localhost:8888/customer/create

Request Body

{
    "username":"pablo",
    "password":"escobar",
    "mobile":"9874568721"
}

Response Body

{
  "adminId": 1,
  "username": "pablo",
  "password": "escobar",
  "address": null,
  "mobile": "9874568721",
  "email": null
}

vishal9sep/Online-Cab-Booking-App