CSE 341: Web Services

W02 Assignment: Books and Authors

Complete the learning activities first

Before beginning this assignment, complete the Week 02 learning activities. The assignment assumes that you understand how write routes connect to MongoDB, how documents can reference each other, and how Swagger can be used to document and test your API.

Overview

In this assignment, you will continue the Books API you began in Week 01. You will add more CRUD behavior, create a related authors collection, and create Swagger documentation and use it to test your API.

Week 02 follows the same assignment process as Week 01, but you will make more of the implementation decisions yourself.

Process Overview

Follow the same professional workflow you practiced in Week 01:

  1. Develop a specification that defines the data models, routes, status codes, and relationship between books and authors.
  2. Create GitHub issues from that specification, with a clear Test Plan for each issue.
  3. Implement the issues one at a time using branches and pull requests.
  4. Test each completed route locally through Swagger at /api-docs.
  5. Deploy the updated API to Render and verify the deployed Swagger documentation and routes.
  6. Reflect on your work using specific evidence from your code, GitHub issues, pull requests, Swagger, and deployed app.

Assignment Parts

Complete the assignment in the following order:

  1. Part 1 - Develop the Specification
  2. Part 2 - Create the Plan
  3. Part 3 - Implement the Plan
  4. Part 4 - Reflect

Next Step

Begin with Part 1 - Develop the Specification.

After you have completed all parts of the assignment, return to Canvas to submit your required links and reflection document. Be prepared to provide your GitHub repository URL, deployed Render URL, walk-through video link, and any issue or pull request evidence requested in Canvas.

Other Links: