-
Notifications
You must be signed in to change notification settings - Fork 14.6k
New Lesson: Basic REST API #29090
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
New Lesson: Basic REST API #29090
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work overall. I suggested a few minor changes to improve the flow and clarity.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Went through the article and it's looking great. I've made a few corrections and grammar improvement suggestions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
General comment: this lesson uses the term URI 4 times, and URL 9 times. Is there (for the content of this lesson) a meaningful difference expressed with that? Otherwise it should be probably use one of those consistently.
Excluding that and a few minor nits I think overall it looks great
Co-authored-by: Asartea <[email protected]> Co-authored-by: Mayada <[email protected]> Co-authored-by: Henrique Heron <[email protected]>
Co-authored-by: Mayada <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made a few other small tweaks for readability.
Co-authored-by: Mayada <[email protected]>
Apologies for the delay. Completely forgot about it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good to me 🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: For consistency with the revamped lessons, instead of "ExpressJS", it should be referred to simply as "Express".
Occurs in text on lines 98, 109 and 110.
@MaoShizhong @01zulfi - if it's all right, this should be good to merge? |
@Lofty-Brambles Yea, everything looks good. I'll merge all the PRs related to the milestone at a later date, most likely together |
|
||
- [What is CRUD?](https://www.codecademy.com/article/what-is-crud) | ||
- [What are the four main HTTP methods, and how are they used?](#crud-and-http-methods) | ||
- [Which HTTP method corresponds to each action in CRUD (Create, Read, Update, Delete)?](https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/#h-use-nouns-instead-of-verbs-in-endpoint-paths) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given the KC question being asked, linking to the appropriate lesson section feels better than linking to an external site.
- [Which HTTP method corresponds to each action in CRUD (Create, Read, Update, Delete)?](https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/#h-use-nouns-instead-of-verbs-in-endpoint-paths) | |
- [Which HTTP method corresponds to each action in CRUD (Create, Read, Update, Delete)?](#crud-and-http-methods) |
I also wonder if this lesson is an appropriate point to drop a quick link to Postman, perhaps at the end of the RESTful APIs section, e.g.
Then it can be re-linked as a reminder in the JWT project (TBD). I was originally going to use it in the JWT lesson but since we're streamlining the "tutorial", I can't find as good a place for an introductory link there and this lesson seems very appropriate IMO. The JWT lesson feels like a better place to reference Postman as if it's already been introduced. Thoughts @01zulfi @Lofty-Brambles ? |
Because
New lesson on Basic REST APIs. Part of Milestone
#2
of the Node Revamp.This PR
#2
.Issue
Closes #28832
Additional Information
The Markdown Preview tool does not render the nested list under assignments and tables properly. The style for those was copied from other, currently active lessons.
Pull Request Requirements
location of change: brief description of change
format, e.g.Intro to HTML and CSS lesson: Fix link text
Because
section summarizes the reason for this PRThis PR
section has a bullet point list describing the changes in this PRIssue
section