Lesson 10: API Gateways and Managers
Overview
Introduction
Welcome to lesson ten! This week you will continue to work on your final project by writing API contracts.
Learning Material
Resources for this lesson are accessible to you in this repository
The following learning material may be helpful but is not required. Please reference the syllabus for more details.
This is an example that would walk you through setting up an API manager through Microsoft Azure.
Team Assignment
Overview
Purpose: Design an API and create accessible API documentation
Task: Complete the assignment
Learning Objectives
By the end of this assignment the student will be able to do the following:
- Work with a team to design an API with documentation
- Deploy API documentation
- Rank yourself against your peers
Assignment Description
Final Project Contracts
- Your assignment for this lesson will be 100% dedicated to your team project for this portion of the semester.
- Create your Swagger API documentation that will be used by your backend team and the frontend team (for on campus students). It might be helpful to review the resources from week 4. Having these contracts in place is probably one of the most difficult parts of a project. Once these are in place, you can just write code until your Swagger doc can successfully execute these requests. It sets up a plan, an outline and a way to test your entire application.
- Your Swagger documentation should be published to Render and available at the following route:
/api-docs. - Create a brief video that goes through the endpoints planned out in the documentation. Upload it to YouTube.
- Submit your YouTube link and your API contracts in I-Learn. (This will be your Render link, for example:
https://cse341-code-student.onrender.com//api-docsas shown in the following example:
Rubric
| Criteria | Weight | Mastery | Proficient | Developing | Beginning | Missing/Incomplete |
|---|---|---|---|---|---|---|
| 100% | 90% | 78% | 65% | 0% | ||
Project Creation(Graded via YouTube) | 45% | Meets Proficient criteria and has documentation in place ("/api-docs" or Apollo Server for GraphQL) | Meets Developing criteria and is deployed to Render | Meets Beginning criteria and project runs without errors | Node project has been created | GitHub, Render or YouTube links not submitted |
Deployed(Graded via YouTube) | 45% | Meets Proficient criteria and the documentation can test at least one endpoint successfully (Should show in video) | Meets Developing criteria and documentation has endpoints for each API Endpoint planned in the Lesson 9 Proposal (API Endpoint Planning section) | Meets Beginning criteria and documentation is organized by collection type | Deployed link submitted - Render link submitted with "/api-docs" in the url (or Apollo link for GraphQL). Video uses this deployed link for all demonstrations | Render link or YouTube link not submitted |
Team Ranking(Graded via I-learn) | 10% | Meets Proficient criteria and includes additional comments about how the team worked together | Meets Developing criteria and includes list of team members in order of work load this lesson | Meets Beginning criteria and includes spread (high, medium, low) | Submitted ranking | No ranking submitted |