Automobile API

A web server where you can register your automobiles, drivers and automobile usage.

Badges

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PORT

Installation

Install the Automobile API with npm

  npm i 
  cd autombile_api

To start the server in development mode, run the following cmd:

  npm run dev

Then you should see a message similar to:

  Server listening on port 3333

To build the server for production, run the following cmd:

  npm run build

To start the server on production mode run:

  npm run start

Tests

You can run the following types of automatic tests:

• Unit
• Integration

To execute the unit tests, run:

  npm run test:unit 

To execute the integration tests (e2e), run:

  npm run test:integration

To run all tests and see its coverage, run:

  npm run test:ci

API Reference

Automobiles

Get all automobiles

  GET /automobiles?color=foo&brand=baa

Parameter	Type	Description
color	string	Optional. Filter by colour
brand	string	Optional. Filter by brand

Request Example:

No body

Response Example:

{
	"data": {
		"ok": true,
		"automobile": [
			{
				"id": "934e1576-0ecd-45fe-8e59-d850078cf0ea",
				"licensePlate": "AAA1A11",
				"color": "Azul",
				"brand": "Toyota"
			},
			{
				"id": "3000bdb0-49fa-40f4-883d-1acf2072473b",
				"licensePlate": "AAA1A12",
				"color": "Green",
				"brand": "Toyota"
			}
		]
	}
}

Get an automobile by ID

  GET /automobiles/${id}

Parameter	Type	Description
id	string	Required. Id of the automobile

Request Example:

No body

Response Example:

{
	"data": {
		"ok": true,
		"automobile": {
			"id": "3000bdb0-49fa-40f4-883d-1acf2072473b",
			"licensePlate": "AAA1A12",
			"color": "Green",
			"brand": "Toyota"
		}
	}
}

Register an automobile

  POST /automobiles

Parameter	Type	Description
licensePlate	string	Required. Automobile license plate
color	string	Required. Automobile color
brand	string	Required. Automobile brand

Request Example:

{
	"licensePlate": "AAA1A12", // No space - needs to be unique
	"color": "Green",
	"brand": "Toyota"
}

Response Example:

{
	"data": {
		"ok": true,
		"automobile": {
			"id": "3000bdb0-49fa-40f4-883d-1acf2072473b",
			"licensePlate": "AAA1A12",
			"color": "Green",
			"brand": "Toyota"
		}
	}
}

Update an automobile

  PUT /automobiles/${id}

Parameter	Type	Description
id	string	Required. Id of the automobile
licensePlate	string	Optional. Automobile license plate
color	string	Optional. Automobile color
brand	string	Optional. Automobile brand

Request Example:

{
	"color": "Yellow"
}

Response Example:

{
	"data": {
		"ok": true,
		"automobile": {
			"id": "3000bdb0-49fa-40f4-883d-1acf2072473b",
			"licensePlate": "AAA1A12",
			"color": "Yellow",
			"brand": "Toyota"
		}
	}
}

Delete an automobile

  DELETE /automobiles/${id}

Parameter	Type	Description
id	string	Required. Id of the automobile

Request Example:

No body

Response Example:

No body - Status 204

Drivers

Get all drivers

  GET /drivers?name=foo

Parameter	Type	Description
name	string	Optional. Filter by name

Request Example:

No body

Response Example:

{
	"data": {
		"ok": true,
		"driver": [
			{
				"id": "608b4fb5-9eb3-46d5-bc22-d92fdc73a04e",
				"name": "John"
			},
			{
				"id": "1bd7d853-6b5e-45e0-8a92-2cba23c26287",
				"name": "Paul"
			}
		]
	}
}

Get a driver by ID

  GET /drivers/${id}

Parameter	Type	Description
id	string	Required. Id of the driver

Request Example:

No body

Response Example:

{
	"data": {
		"ok": true,
		"driver": {
			"id": "608b4fb5-9eb3-46d5-bc22-d92fdc73a04e",
			"name": "John"
		}
	}
}

Register a driver

  POST /drivers

Parameter	Type	Description
Name	string	Required. Driver name

Request Example:

{
	"name": "Paul"
}

Response Example:

{
	"data": {
		"ok": true,
		"driver": {
			"id": "1bd7d853-6b5e-45e0-8a92-2cba23c26287",
			"name": "Paul"
		}
	}
}

Update a driver

  PUT /drivers/${id}

Parameter	Type	Description
id	string	Required. Id of the driver
name	string	Required. Driver new name

Request Example:

{
	"name": "George"
}

Response Example:

{
	"data": {
		"ok": true,
		"driver": {
			"id": "1bd7d853-6b5e-45e0-8a92-2cba23c26287",
			"name": "George"
		}
	}
}

Delete a driver

  DELETE /drivers/${id}

Parameter	Type	Description
id	string	Required. Id of the driver

Request Example:

No body

Response Example:

No body - Status 204

Automobile Usages

Get all usages

  GET /usages

Request Example:

No body

Response Example:

{
	"data": {
		"ok": true,
		"automobileUsage": [
			{
				"id": "9faa8905-1d50-4f03-8811-96e4e3b9b9b5",
				"startDate": "11/12/23",
				"driver": {
					"id": "02d542d5-cd94-421f-9ac2-0842fe8f855a",
					"name": "Paul"
				},
				"automobile": {
					"id": "19a28d9c-9553-4c87-b208-53acaa05af0c",
					"licensePlate": "AAA1A12",
					"color": "Green",
					"brand": "Toyota"
				},
				"reason": "Merchandise transport"
			},
			{
				"id": "356b270b-36db-415a-a809-88a9323605d2",
				"startDate": "12/12/23",
				"driver": {
					"id": "d460736f-e98c-4d37-bb8c-75a0acd47a64",
					"name": "John"
				},
				"automobile": {
					"id": "2ef73fc1-f781-49b3-8943-7282b5984065",
					"licensePlate": "AAA1A13",
					"color": "Green",
					"brand": "Toyota"
				},
				"reason": "Merchandise transport"
			}
		]
	}
}

Register a automobile usage

  POST /usages

Parameter	Type	Description
startDate	string	Required. Start the use of the automobile
driverId	string	Required. Driver ID using the automobile
automobileId	string	Required. Automobile ID being used
reason	string	Required. Why the automobile is being used

Request Example:

{
	"startDate": "11/12/23",
	"driverId": "02d542d5-cd94-421f-9ac2-0842fe8f855a",
	"automobileId":"19a28d9c-9553-4c87-b208-53acaa05af0c",
	"reason": "Merchandise transport"
}

Response Example:

{
	"data": {
		"ok": true,
		"automobileUsage": {
			"id": "9faa8905-1d50-4f03-8811-96e4e3b9b9b5",
			"startDate": "11/12/23",
			"driver": {
				"id": "02d542d5-cd94-421f-9ac2-0842fe8f855a",
				"name": "Paul"
			},
			"automobile": {
				"id": "19a28d9c-9553-4c87-b208-53acaa05af0c",
				"licensePlate": "AAA1A12",
				"color": "Green",
				"brand": "Toyota"
			},
			"reason": "Merchandise transport"
		}
	}
}

Update a usage

  PUT /usages/${id}

Parameter	Type	Description
id	string	Required. Id of the automobile usage
endDate	string	Required. Final usage date

Request Example:

{
	"endDate": "15/12/23"
}

Response Example:

{
	"data": {
		"ok": true,
		"automobileUsage": {
			"id": "356b270b-36db-415a-a809-88a9323605d2",
			"startDate": "12/12/23",
			"driver": {
				"id": "d460736f-e98c-4d37-bb8c-75a0acd47a64",
				"name": "John"
			},
			"automobile": {
				"id": "2ef73fc1-f781-49b3-8943-7282b5984065",
				"licensePlate": "AAA1A13",
				"color": "Green",
				"brand": "Toyota"
			},
			"reason": "Merchandise transport",
			"endDate": "15/12/23"
		}
	}
}

License

MIT