-
Notifications
You must be signed in to change notification settings - Fork 317
Assignment 10 Jobs API part 2
Complete and test all CRUD operations for your model (or the Jobs model). Be sure that each operation uses the ID of the user, so that you have good access control.
Test each step with Postman, creating a Postman collection of tests just like the instructor is doing.
You deploy your application once you have your assignment completed and working, and once you have pushed your week10 branch to Github.
To deploy to Render.com, follow these steps:
- Specify the version of Node that Render is to use. One way is to create a
.node-versionfile in the root of your project repository, specifying the same version of node as you are running on your machine. On my machine, when I typenode -v, I get back v16.19.0 . So I would create a.node-versionfile with the single line:16.19.0 - Create a Render.com account. You do not need to install anything on your workstation for Render deployment. You do not need to enter any credit card information.
- From your Render.com dashboard, click on the New button in the upper right. Select Web Service. You will then be prompted to connect a repository. Scroll down to the entry field that says “public git repository”, and enter the URL of your 06-jobs-api repository. Then press continue.
- The next page prompts you for the name of the service. This becomes the first part of the URL for your application. You need to give it a unique name that no one else is using, maybe something like
jobs-api-<your name>. - Scroll down to the entry field for branch. Put in
week10. - Scroll down until you see the “advanced” button. Click on that. You then click on Add Environment Variable. You need to add an environment variable for each of the values in your .env file: the Mongo URI, the JWT key, and so on.
- Scroll to the bottom and click on Create Web Service. Render.com then builds the application for deployment. The process takes a while. Once the process completes, you see a link in the upper right for your new web service. The URL will be something like
https://jobs-api-<your name>.onrender.com. - Copy that URL and put it into your Postman tests for the assignment. Then test with Postman. Your application is live!
The section of the video from 9:34:30 to the end discusses setting up a Swagger configuration. When you have an API, you need to document it so that implementers of applications that call the API (like the frontend) know what the available endpoints and operations are. Swagger is the best way to do that. It also creates a graphical user interface so that one can call the APIs directly from the UI. You should watch this section so that you understand how a Swagger configuration may be created and what functions it provides. However, this section of the video gets a bit complicated, so you are not required to implement Swagger for your application, but it’s a great idea to watch this section and familiarize yourself with the concept of Swagger. If possible, try to implement it as a bonus task this week.
Last week in your lesson, we wanted you to start thinking about your final project. On the assignment submission form this week you'll need to enter in details about the project you want to build. Your assignment reviewer will read your responses and either approve your project for you to start building as your final project, or will suggest changes. If you don't hear from your reviewer by the end of this coming week (the review week) please contact your Cohort Leader.
The details you'll need to share are:
- Project Concept: what is the idea and purpose of your project?
- Project Data Models: what types of data will you be using in your project and how do those pieces of data need to connect with each other?
- Project Features/Functions: what additional features or functionality will your project include? (ex. login, authentication, testing, etc.)
If you're not sure where to start with your project idea, schedule a 1:1 mentor session and talk through it! We're here to help!