Assignment 4: Microservice Proposal

Due: Tuesday the 24th of March at 11:59 pm

Purpose

• Submit a proposal for your microservice using both human english and the OpenAPI specification.

Partners

Partners are allowed.

Assignment

• Ensure your github user names are within the GROUPS.md file and add link to the directory structure (including a new group name you come up with)
• Submit a proposal/design in the form of a subdirectory under services with corresponding markdown and yaml files
• Create a README.md and list the project name, description, and project partner(s). Choose a group name (becomes part of directory structure)
• Answer the following within the README.md:
  
  • Where will it be hosted (esus, personal website, google, AWS, Azure, etc...)?
  • What will the endpoint look like? Include a few example requests and responses.
  • What language/framework/tech stack you will use?
  • Show how it can be tested (cURL requests, javascript client i.e. react app, etc...)
• Create a corresponding api.yaml specification defining at least 1 GET endpoint exposing an input parameter that will affect the response output. The api.yaml file must be based on the open API v3.0 standard and compile properly..

Sample File Structure

./services/*group-name*/README.md
./services/*group-name*/api.yaml

Grading - 10 points

• 1 point - top level GROUPS.md file updated with link and group name
• 4 points - README.md proposal is created as specified
• 5 points - api.yaml OpenAPI v3.0 specification describing the endpoint(s)