car_manager

About this repository:

This is a REST API project using Node express framwork, mongoose and MongoDB. The car manager contains 2 resources, User and Cars.

Each user can have a list of cars.The objective of this project is to get familiar with Express and mongoose after finishing the MDN tutorial

End points:

/car/all (GET)

List all the cars.

Query:
http://localhost:30000/car/all


Response:
{
    "carList": [
        {
            "URL": "/car/5fdfb56ccb14c32bae505ee5/detail",
            "carBrand": "Chevrolet",
            "productYear": "1988-01-01T00:00:00.000Z"
        },
        {
            "URL": "/car/5fdfb56ccb14c32bae505ee6/detail",
            "carBrand": "Aston Martin",
            "productYear": "2010-01-01T00:00:00.000Z"
        },
        {
            "URL": "/car/5fdfb56ccb14c32bae505ee7/detail",
            "carBrand": "Maserati",
            "productYear": "1970-01-01T00:00:00.000Z"
        },
        {
            "URL": "/car/5fdfb56ccb14c32bae505ee8/detail",
            "carBrand": "Nissan",
            "productYear": "1974-01-01T00:00:00.000Z"
        },
        {
            "URL": "/car/5fdfb56ccb14c32bae505ee9/detail",
            "carBrand": "Mercedes Benz",
            "productYear": "1967-01-01T00:00:00.000Z"
        }
    ]
}

/car/:id/detail (GET)

get all the information of a specific car

Query:
http://localhost:30000/car/5fe276b6d15444804510bcd2/detail


Response:
{
    "car": {
        "URL": "/car/5fe276b6d15444804510bcd2/detail",
        "carBrand": "Volkswagen",
        "carModel": "e-Golf",
        "carFullname": "Volkswagen - e-Golf",
        "productYear": "1988-01-01T00:00:00.000Z"
    }
}

car/create (POST)

create a new car

required field: carBrand carModel

Example:

Query:
http://localhost:30000/car/create

Body:
 {
        "carBrand": "Tesla",
        "carModel": "T1",
        "productYear": "2010-01-01T00:00:00.000Z",
        "convertible": true
}



Response:
{
    "newCar": {
        "URL": "/car/5fe5e50d50fd6f5528726d54/detail",
        "carBrand": "Tesla",
        "carModel": "T1",
        "carFullname": "Tesla - T1",
        "productYear": "2010-01-01T00:00:00.000Z",
        "convertible": true
    }
}

car/:id/update (PUT)

Update a specific Car:

Example:

Query:
http://localhost:30000/car/5fe276b6d15444804510bcd2/update


Body:
{
    "carBrand": "volkswagen",
    "carModel": "e-Golf",
    "productYear": "1988-01-01T00:00:00.000Z"
}

Response:
{
    "modifiedCar": {
        "URL": "/car/5fe276b6d15444804510bcd2/detail",
        "carBrand": "volkswagen",
        "carModel": "e-Golf",
        "carFullname": "volkswagen - e-Golf",
        "productYear": "1988-01-01T00:00:00.000Z"
    }
}

car/:id/delete (DELETE)

Delete a specific Car

Response:
{
    "message": "Car deleted successfully"
}

users/:id/detail (GET)

Get all information about a user

Query:
http://localhost:30000/users/5fe3e218bcf67148aa006050/detail


Response:
{
    "user": {
        "firstName": "Rotsen",
        "lastName": "santiago",
        "email": "rotsen_santi@test.com",
        "gender": "Male",
        "URL": "/users/5fe3e218bcf67148aa006050/detail",
        "car": [
            {
                "carBrand": "SEAT",
                "carModel": "Leon",
                "URL": "/car/5fdfb56ccb14c32bae505eef/detail",
                "fullName": "SEAT - Leon"
            },
            {
                "carBrand": "Chevrolet",
                "carModel": "CAMARO",
                "URL": "/car/5fdfb56ccb14c32bae505ee5/detail",
                "fullName": "Chevrolet - CAMARO"
            }
        ]
    }
}

users/create

Create a new user

Query:
http://localhost:30000/users/create

Body:
{
     "firstName": "Alicia",
        "lastName": "Martinez",
        "email": "alicia_martinez@test.com",
        "gender": "Female",
        "car": []
}

Response:
{
    "newUser": {
        "firstName": "Alicia",
        "lastName": "Martinez",
        "email": "alicia_martinez@test.com",
        "gender": "Female",
        "URL": "/users/5fe5e36650fd6f5528726d53/detail",
        "car": []
    }
}

users/:id/update

Update an existent user profile

Query:
http://localhost:30000/users/5fe3e218bcf67148aa006050/update

Body:
{
     "firstName": "Rotsen",
        "lastName": "santiago",
        "email": "rotsen_santi@test.com",
        "gender": "Male",
        "car": []
}

Response:
{
    "updatedUser": {
        "firstName": "rotsen",
        "lastName": "santiago",
        "email": "rotsen_santi@test.com",
        "gender": "Male",
        "URL": "/users/5fe3e218bcf67148aa006050/detail",
        "car": [
            "5fdfb56ccb14c32bae505eef",
            "5fdfb56ccb14c32bae505ee5"
        ]
    }
}

How to install the project:

This is a NPM project, please install all the dependencies using NPM package manager. The data base is running in Mongo Atlas, the DB credentials are loaded from an envoriment variable.(gitignored) If you want to run this project locally, please create a mongo data base on your own.

To install the dependencies:

npm install

To run the project:

npm run start