Phone-App project contains of sub projects:
- phone-catalog-api
- order-api
http://${PHONE_CATALOG_HOST_IP}:8091/actuator/healthhttp://${ORDER_API_HOST_IP}:8090/actuator/health
{
"status" : "UP",
"details" : {
"diskSpace" : {
"status" : "UP",
"details" : {
"total" : 500068036608,
"free" : 91716366336,
"threshold" : 10485760
}
},
"db" : {
"status" : "UP",
"details" : {
"hello" : 1,
"database" : "H2"
}
}
}
}
http://${PHONE_CATALOG_HOST_IP}:8091/actuator/infohttp://${ORDER_API_HOST_IP}:8090/actuator/info
{
"git" : {
"branch" : "master",
"commit" : {
"id" : "6694750",
"time" : "2019-03-11T11:50:29Z"
}
},
"build" : {
"group" : "com.vmi.phone.catalog",
"version" : "0.0.1",
"time" : "2019-03-22T09:57:46.468Z",
"name" : "phone-catalog-api",
"artifact" : "phone-catalog-api"
}
}
http://${PHONE_CATALOG_HOST_IP}:8091/swagger-ui.html- phone-catalog-api servicehttp://${ORDER_API_HOST_IP}:8090/swagger-ui.html- order-api service
Phone catalog API is a service that provides access to phone models and their prices via REST API. Data is stored in H2 DB. Phone catalog API provides following endpoints for phones retrieval:
Request
curl -X GET http://localhost:8091/phone-catalog/rest/v1/phones
Response, HTTP 1.1 200 OK "application/json;charset=UTF-8"
[
{
"id": "a237864b-7d2a-41a7-8c17-2fdb56a3dc6c",
"name": "Google Pixel 2",
"description": "Android 7.1 (Nougat), upgradable to Android 9.0 (Pie) Chipset\\nQualcomm MSM8996 Snapdragon 821 (14 nm) CPU\\nQuad-core (2x2.15 GHz Kryo & 2x1.6 GHz Kryo)GPU Adreno 530",
"imageUrl": "https://cdn2.gsmarena.com/vv/pics/google/google-pixel-xl-2.jpg",
"price": "699.00",
"currency": "USD"
},
{
"id": "8d58766b-44d5-4079-8faf-cf10da10133f",
"name": "Some new very fancy phone",
"description": "Coming soon...",
"imageUrl": "NA",
"price": "0.00",
"currency": "USD"
}
]Request
curl -X GET http://localhost:8091/phone-catalog/rest/v1/phones/a237864b-7d2a-41a7-8c17-2fdb56a3dc6c
Response, HTTP 1.1 200 OK "application/json;charset=UTF-8"
{
"id": "a237864b-7d2a-41a7-8c17-2fdb56a3dc6c",
"name": "Google Pixel 2",
"description": "Android 7.1 (Nougat), upgradable to Android 9.0 (Pie) Chipset\\nQualcomm MSM8996 Snapdragon 821 (14 nm) CPU\\nQuad-core (2x2.15 GHz Kryo & 2x1.6 GHz Kryo)GPU Adreno 530",
"imageUrl": "https://cdn2.gsmarena.com/vv/pics/google/google-pixel-xl-2.jpg",
"price": "699.00",
"currency": "USD"
}Order API is intended to process order information received from API client, validate data and return order details, such as phone models specs, customer information and total price.
Request
curl -X POST http://localhost:8090/order-api/rest/v1/order-information \
-H 'Content-Type: application/json' \
-d '{
"items": [
{
"id": "7ba92093-5397-4d5f-a398-7873a40a3bd0",
"quantity": 10
},
{
"id": "5caca2a8-49f6-4b87-a558-bd22b434d479"
}
],
"customer": {
"firstName": "User",
"lastName": "Foo",
"email": "[email protected]"
}
}'
Response, HTTP 1.1 200 OK "application/json;charset=UTF-8"
{
"customer": {
"firstName": "User",
"lastName": "Foo",
"email": "[email protected]"
},
"items": [
{
"quantity": 10,
"price": "8003.30",
"phone": {
"id": "a222bc71-c770-4960-8d9e-532d65286e79",
"name": "Samsung Galaxy A9 Star Pro",
"description": "Android 8.0 (Oreo)\\nChipset Qualcomm SDM660 Snapdragon 660 (14 nm)\\nOcta-core (4x2.2 GHz Kryo 260 & 4x1.8 GHz Kryo 260)\\nGPU Adreno 512\\nCard slot microSD, up to 512 GB (dedicated slot)\\n128 GB, 6/8 GB RAM",
"imageUrl": "https://cdn2.gsmarena.com/vv/pics/samsung/samsung-galaxy-a9-2018-1.jpg",
"price": "800.33",
"currency": "USD"
}
},
{
"quantity": 1,
"price": "699.00",
"phone": {
"id": "4a268f38-953f-4bb0-8935-56732c08b73c",
"name": "Google Pixel 2",
"description": "Android 7.1 (Nougat), upgradable to Android 9.0 (Pie) Chipset\\nQualcomm MSM8996 Snapdragon 821 (14 nm) CPU\\nQuad-core (2x2.15 GHz Kryo & 2x1.6 GHz Kryo)GPU Adreno 530",
"imageUrl": "https://cdn2.gsmarena.com/vv/pics/google/google-pixel-xl-2.jpg",
"price": "699.00",
"currency": "USD"
}
}
],
"totalPrice": "8702.30",
"currency": "USD"
}This project is using Gradle build tool. In order to build it we need to change dir to phone-app project and invoke gradle wrapper build command from terminal:
cd {path-to-phone app}/phone-app
...
./gradlew clean build
In order to start both order-api and phone-catalog-api, we need start those service separately in two terminal instances:
./gradlew :phone-catalog-api:bootRun
./gradlew :order-api:bootRun
Once services started, API are ready to use.
In order to build Docker image, Docker should be installed on local machine. Ensure that dir is changed to phone-app root folder.
Easiest way build and start services locally is to use docker-compose tool that will build and start necessary images
docker-compose up
docker build --build-arg SERVICE_NAME=phone-catalog-api --build-arg SERVICE_PORT=8091 -t phone-catalog-api .
docker build --build-arg SERVICE_NAME=order-api --build-arg SERVICE_PORT=8090 -t order-api .
docker run -p "8091:8091" -ti phone-catalog-api:latest
docker run -p "8090:8090" -ti order-api:latest
Once images started we are ready to use our APIs.
- in order to have reliable order processing system whe should configure service auto scaling. If we deploy our services to cloud, we need to take care about load balancing: define rules for scale in and scale out policies, that depending on CPU usage, memory consumption, time of the day (based on forecast about peak number of orders), etc.
- configure alerts based on unsuccessful error codes returned by elb, exception stack traces in logs, if present, etc (Cloud watch can be used in we use AWS for hosting)
- phone models caching can be a good idea
- add security, use existing solution (as an example use AWS API Gateway to configure auth on front of application load balancer), use SSL etc.
- perform load testing to have insights about application bandwidth
- support environments, sine current app works with one env, for real world use cases we need to have non prod env for testing
- for production use H2 should be changed to MySQL DB (AWS RDS or other instance)