Skip to content

Latest commit

 

History

History
141 lines (120 loc) · 3.75 KB

documentation.md

File metadata and controls

141 lines (120 loc) · 3.75 KB
Raw

Car Booking API Documentation

 API URL: https://murmuring-tor-45890.herokuapp.com/api/v1/

SingUp

 API URL: https://murmuring-tor-45890.herokuapp.com/api/v1/users/signup


{
    "user":
    {
        "name": "kandy",
        "email": "[email protected]"
        "password": "admin1234",
        "confirm_password": "admin1234"
    }
}

Login

 API URL: https://murmuring-tor-45890.herokuapp.com/api/v1/users/login


{
    "user":
    {
        "email": "[email protected]"
        "password": "admin1234",
    }
}

List all cars

 API URL: https://murmuring-tor-45890.herokuapp.com/api/v1/cars


{
    "cars":
    {
        "id": 1
        "name": "Lamborgini",
        "model": "Chiron",
        "reserved": true,
        "per_day_amount": 200,
        "image": "https://www.kmpdrivetrain.com/wp-content/uploads/2021/06/Bugatti-Veyron_Overview.png"
    },
    {
        "id": 2
        "name": "Range Rover",
        "model": "Sport",
        "reserved": true,
        "per_day_amount": 200,
        "image": "https://www.kmpdrivetrain.com/wp-content/uploads/2021/06/Bugatti-Veyron_Overview.png"
    },
}

Get unique car

 API URL: https://murmuring-tor-45890.herokuapp.com/api/v1/cars/{id}


{
    "cars":
    {
        "id": 6
        "name": "Lamborgini",
        "model": "Chiron",
        "reserved": true,
        "per_day_amount": 200,
        "image": "https://www.kmpdrivetrain.com/wp-content/uploads/2021/06/Bugatti-Veyron_Overview.png"
    },
}

List reservations

 API URL: https://murmuring-tor-45890.herokuapp.com/api/v1/reservation


 {
    status: "SUCCESS",
    massage: "Loaded Reservations",
    data: [
             {
                id: 10,
                date: "2022-06-20",
                city: "kigali",
                created_at: "2022-06-30T10:10:21.159Z",
                updated_at: "2022-06-30T10:10:21.159Z",
                user_id: 1656543733619,
                car_id: 6
             },
             {
                id: 9,
                date: "2022-06-20",
                city: "Los Angeles",
                created_at: "2022-06-30T08:11:00.275Z",
                updated_at: "2022-06-30T08:11:00.275Z",
                user_id: 1656576577228,
                car_id: 6
             }
         ]
}

User authorized car methods:

method api request data sent
POST https://murmuring-tor-45890.herokuapp.com/api/v1/cars/ name, per_day_amount, model, car_image
DELETE https://murmuring-tor-45890.herokuapp.com/api/v1/cars/{id}/

User authorized reservations methods:

method api request data sent
POST https://murmuring-tor-45890.herokuapp.com/api/v1/reservation/ city, car, date
DELETE https://murmuring-tor-45890.herokuapp.com/api/v1/reservation/{id}/