Project 5: Microservice Proposal
Due: Tuesday the 26th of February at 4:00 pm
Purpose
- Submit a proposal for your microservice
Partners
Partners are allowed.
Assignment
- Submit a proposal/design in the form of a subdirectory under projects with corresponding markdown files
- List the project name, description, and project partner(s). Choose a group name (becomes part of directory structure)
- Indicate what the signature of the endpoint is with a few example requests and responses
- Indicate where it will be hosted (google, AWS, Azure, etc...)
- Indicate what language/framework/tech stack you will use
- Indicate how it will be tested (cURL requests, javascript client i.e. react app, etc...)
- Create a corresponding api.yaml specification based on the open API v3.0 standard.
Sample File Structure
./projects/calculator/group_name/README.md
./projects/calculator/group_name/api.yaml
Grading - 10 points
- 5 points - README.md proposal is created as specified above and merged into sleddog/methods and the instructor (sleddog) was mentioned in the pull request
- 5 points - api.yaml OpenAPI v3.0 specification describing the endpoints