6156-microservice-1

Simple starter template from Professor's template project.

Directory Structure

Folders and files

• data/: json files containing data

• resources/: supportive python scripts

  • entityxxx: the entity in the microservice structure
    • xxx_data_service: a class that understands how to connect to an external database and get data in and out of the database. (Eventually it will connect to database, but for now it reads data from ./data/xxx.json.)
    • xxx_resources: an interface to data_service.
    • xxx_models: the data objects that can go back and forth in OpenAPI. (also define attributes here)

• static/: html files

• tts/: test cases

  • It contains test cases for every xxx_data_service and xxx_resource in ./resources/.

• main.py is the python application launched to start the web service.

  • also implement paths here.

• The .gitignore file is the default for python from GitHub and prevents pushing the virtual environment and python-related files into the repo.

Python Virtual Environment

• Using a python virtual environment is a best practice.

• This projects virtual environment is in venv.

Links

• 6156 Project CC98BBS

Final Project Functionalities

• Enhance Microservices Implementation:
  • Core operations (GET, PUT, POST, DELETE) from each microservice.
  • Show results changing with provided query parameters.
• Events, Notifications, Pub/Sub:
  • Take a screenshot of your code publishing events to any queue systems (SNS, Google Pub/Sub).
  • Make a request to a microservice and Lambda function handling the published events.
• Composition/Aggregators:
  • Demonstrate a synchronous call that prints a log when getting a response from each microservice.
  • Demonstrate an asynchronous call that prints a log when getting a response from each microservice. (repeat it 10 times, and it should microservices should be done in a different order at least once).
• API Gateway:
  • Demonstrate your API Gateway Implementation, which shows both authorized and unauthorized cases.
• Single Sign-On (SSO):
  • Demonstrate SSO login and make an authorized request using the given token.
• External API:
  • Explain what External API you are using and what this is for in your application, and demonstrate the functionality.
• Middleware
  • Introduce one Middleware functionality in your application and explain what it does.
• CI/CD
  • Demonstrate your CI/CD pipelines running on specific events.
• Infrastructure As Code
  • Deploy and shut down any simple infrastructure in your project.
• GraphQL
  • Implement a simple example of GraphQL using one of the functionalities of your application.