New Lesson: Basic REST API#29090
Conversation
Maddily
left a comment
There was a problem hiding this comment.
Great work overall. I suggested a few minor changes to improve the flow and clarity.
HenriqueHeron
left a comment
There was a problem hiding this comment.
Went through the article and it's looking great. I've made a few corrections and grammar improvement suggestions.
Asartea
left a comment
There was a problem hiding this comment.
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 <76259120+Asartea@users.noreply.github.com> Co-authored-by: Mayada <115709272+Maddily@users.noreply.github.com> Co-authored-by: Henrique Heron <44820991+autotelico@users.noreply.github.com>
Co-authored-by: Mayada <115709272+Maddily@users.noreply.github.com>
Maddily
left a comment
There was a problem hiding this comment.
Made a few other small tweaks for readability.
Co-authored-by: Mayada <115709272+Maddily@users.noreply.github.com>
|
Apologies for the delay. Completely forgot about it. |
mao-sz
left a comment
There was a problem hiding this comment.
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 |
|
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 ? |
|
Just realised that Postman is already first introduced in the Routes lesson, but I still think a quick re-mention of Postman here might be valuable. Thoughts? |
Contents sufficiently covered in lesson itself
Because
New lesson on Basic REST APIs. Part of Milestone
#2of 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 changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection