Game shop revisited
This set of REST APIs will support both web and mobile clients for customers. The original design is a traditional monolithic application with a single database. This project is to move the current design and partial implementation to a design that follows the new cloud-native architectural standards
- Manage your project using Pivotal Tracker
- Use Test-Drive Development (TDD)
- Design the backing services losely coupled to Retail and Admin Api
- Use Spring security, Queue, Circuit breaker, feign clients, config server and eureka service registry.
- All configuration are stored in repo: https://github.com/Simonkcoding/capstone2-cloud-config
This section contains all of the functional requirements of the system.
This service runs on port 8181.
The Retail API is a BFF edge service that contains all API endpoints for searching inventory and purchasing products. This API does not require authentication. This API is not documented. You must pull all of the inventory search and product purchasing endpoint from the existing code, document them in Swagger, and reimplement them in the new Retail API Service.
The Retail API Service communicates with the following backing services:
- Level Up
- Order
- Inventory
- Product
- Customer
- 10 Level Up points are awarded for each $50 purchased.
- These points are not pro-rated.
- For example:
- A $49 order gets zero Level Up points.
- A $99 order gets 10 Level Up points.
- A $110 order gets 20 Level Up points.
- For example:
- Level Up points are submitted when the order is submitted.
- Level Up points totals are returned as part of the completed invoice.
- Order quantity must be greater than zero and less than or equal to the number of items in inventory.
- Orders must contain valid products.
- An order must contain a valid customer.
- Level Up points must be submitted to the Level Up service via a queue.
- Level Up total inquiries must be run through a circuit breaker.
- See diagram above.
This service runs on port 8282.
The Admin API is a BFF edge service that contains all the endpoints for CRUD operations of the following:
- Customers
- Products
- Inventory
- Orders
- Level Up Points
This API is not documented and is only partially implemented in the existing code. You must pull out the parts of the API that are implemented in the existing code, model them in Swagger, and reimplement them in the new Admin API service. Use the existing API endpoints as a model for the missing endpoints.
The security rules for the Admin API Service are:
- All Admin API endpoints require authentication.
- Admin Role
- Can access all endpoints.
- Manager Role
- Can Create, Read, and Update all items in the system.
- Team Lead Role
- Can Read and Update all items in the system.
- Can Create Customers in the system.
- Employee Role
- Can read all items in the system.
- Can Update Inventory in the system.
This service runs on port 7001.
This is a microservice that contains all CRUD functionality for the Level Up! rewards system. This service has not been designed. You must design and document the API and implement the entire service.
The Read endpoint of the service must have a circuit breaker.
This service runs on port 7002.
This is a microservice that contains all CRUD functionality for Invoices. This service has not been designed, but a shell implementation of the CRUD endoints for Invoices is in the existing code. Find these endpoints, document the endpoints in Swagger and reimplement them in the new Invoice microservice.
This service runs on port 7003.
This is a microservice that contains all CRUD functionality for inventory. This service has not been designed. You must design and document the API and implement the entire service.
This service runs on port 7004.
This is a microservice that contains all the CRUD functionality for Products. This service contains information on all the Products that the company has sold in the past and may sell in the future. This service does not contain information about current inventory levels. This service has not been designed. you must design and document the API and implement the entire service.
This service runs on port 7005.
This is a microservice that contains all the CRUD functionality for Customers. This service has not been designed. you must design and document the API and implement the entire service.
This service runs on port 9999.
This service runs on port 8761.
This section contains all of the architectural requirements of the system.
All services in the system must use the Configuration Server for all of their configuration files.
All backing services must register with the Service Registry. The Retail API and Admin API web services must use the Service Registry to locate the backing services that they use.
The Admin API must be protected by Spring Security (roles and access rules are found in the Functional Requirements above).
- You must use the default Spring Security schema.
- All passwords must be hashed with BCrypt
Communication to backing services from the Retail API and Admin API web services must be done using Feign clients in a Service Layer component.
All DAOs must use JdbcTemplates and Prepared Statements.
You must incorporate caching as appropriate in the application. Be prepared to explain your design decisions.
- You must implement ControllerAdvice to handle exceptions and return propery HTTP status codes and data when exception occur. This includes handling all violoations of business rules.
- You must use JSR 303 validation where appropriate