New Lesson: Basic REST API by Lofty-Brambles · Pull Request #29090 · TheOdinProject/curriculum

Lofty-Brambles · 2024-11-17T11:26:55Z

Because

New lesson on Basic REST APIs. Part of Milestone #2 of the Node Revamp.

This PR

Adds a fresh lesson as a part of the Node Revamp Milestone #2.

Issue

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

I have thoroughly read and understand The Odin Project curriculum contributing guide
The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
The Because section summarizes the reason for this PR
The This PR section has a bullet point list describing the changes in this PR
If this PR addresses an open issue, it is linked in the Issue section
If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
If any lesson files are included in this PR, they follow the Layout Style Guide

Maddily

Great work overall. I suggested a few minor changes to improve the flow and clarity.

HenriqueHeron

Went through the article and it's looking great. I've made a few corrections and grammar improvement suggestions.

Asartea

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

Made a few other small tweaks for readability.

Co-authored-by: Mayada <115709272+Maddily@users.noreply.github.com>

Lofty-Brambles · 2025-01-03T17:37:39Z

Apologies for the delay. Completely forgot about it.

01zulfi

looks good to me 🚀

mao-sz

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.

Lofty-Brambles · 2025-03-27T07:30:51Z

@MaoShizhong @01zulfi - if it's all right, this should be good to merge?

01zulfi · 2025-03-27T12:25:48Z

@Lofty-Brambles Yea, everything looks good. I'll merge all the PRs related to the milestone at a later date, most likely together

mao-sz · 2025-05-10T17:35:43Z

+
+- [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)


Given the KC question being asked, linking to the appropriate lesson section feels better than linking to an external site.

Suggested change

- [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)

mao-sz · 2025-05-11T13:40:51Z

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.

Since JSON is sent in response, it also allows us to use software like Postman to send requests to our API and display the response, all without needing to create a website to do so.

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 ?

mao-sz · 2025-08-12T21:05:03Z

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?

mao-sz · 2026-02-26T19:13:34Z

+### Additional resources
+
+This section contains helpful links to related content. It isn't required, so consider it supplemental.
+
+- [HTTP Request/Response Basics](http://justahelp.blogspot.com/2013/09/http-requestresponse-basics.html) from Pralay Roy goes into further detail about their lifecycle and anatomy with best practices.


@Lofty-Brambles not sure you're aware but one of the big things the team is going through with the whole curriculum is re-evaluating additional resources and the purpose of the AR section.

Rereading this lesson, I'm wondering how you feel about this AR you've added. Do you feel it's important enough to the lesson to need mentioning on top of everything else covered? If so, is it something that can be integrated into the lesson itself in some way as opposed to as an AR? Or is there a good reason it should not be dropped but must still be separate from the lesson proper?

Lofty-Brambles added 16 commits November 15, 2024 13:58

feat: decide on an appropriate location for the lesson

1f0e3dd

feat: add lesson objectives

cd12dcc

feat: add another point in lesson objectives

42e3f39

feat: add content to the what is an api section

ef55ab4

feat: relocate an introduction

bf95ec7

fix: change sentences about in introduction and rest api sections

853216e

feat: add a http section

e17eba2

feat: add CRUD and HTTP methods section

93ead33

feat: add a section on http codes

ed02ab1

feat: add a section on urls

96d18b3

feat: add a section on RESTful APIs

19c6b97

feat: add a knowledge check

eb3b443

feat: add additional resources

680cd2b

feat: add assignments

6fa51cf

fix: clean up template text

b0f4019

fix: clean up grammar

c932b25

github-actions bot added the Content: NodeJS Involves the NodeJS course label Nov 17, 2024

Maddily reviewed Nov 17, 2024

View reviewed changes

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

HenriqueHeron reviewed Nov 17, 2024

View reviewed changes

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Maddily reviewed Nov 17, 2024

View reviewed changes

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Maddily reviewed Nov 17, 2024

View reviewed changes

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Asartea reviewed Nov 17, 2024

View reviewed changes

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Comment thread nodeJS/apis/RESTful_APIs.md

Lofty-Brambles and others added 4 commits November 18, 2024 19:00

fix: wrangling bad grammar

efd82ac

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>

fix: phrasing

b3b83c2

Co-authored-by: Mayada <115709272+Maddily@users.noreply.github.com>

fix: satisfy markdownlint and URI/URL discrepancy

97ee729

fix: wording around the definition of CRUD

2c46d51

Maddily reviewed Nov 18, 2024

View reviewed changes

mao-sz reviewed Nov 19, 2024

View reviewed changes

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

fix: more grammar issues

a543013

Co-authored-by: Mayada <115709272+Maddily@users.noreply.github.com>

01zulfi requested changes Nov 25, 2024

View reviewed changes

Comment thread nodeJS/apis/RESTful_APIs.md

Comment thread nodeJS/apis/RESTful_APIs.md Outdated

Comment thread nodeJS/apis/RESTful_APIs.md

01zulfi added the Project Node Revamp Issues/PRs related to the Node Revamp project label Dec 11, 2024

feat: rephrasing the API and introduction sections

2575092

Lofty-Brambles requested a review from 01zulfi January 3, 2025 17:35

fix (introduction): satisfy codespell

2aa71bb

01zulfi approved these changes Mar 16, 2025

View reviewed changes

mao-sz reviewed Mar 19, 2025

View reviewed changes

fix: change ExpressJS to Express

7be3515

mao-sz reviewed May 10, 2025

View reviewed changes

mao-sz reviewed Feb 26, 2026

View reviewed changes

	- [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)

Conversation

Lofty-Brambles commented Nov 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Because

This PR

Issue

Additional Information

Pull Request Requirements

Uh oh!

Maddily left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

HenriqueHeron left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Asartea left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Maddily left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lofty-Brambles commented Jan 3, 2025

Uh oh!

01zulfi left a comment

Choose a reason for hiding this comment

Uh oh!

mao-sz left a comment

Choose a reason for hiding this comment

Uh oh!

Lofty-Brambles commented Mar 27, 2025

Uh oh!

01zulfi commented Mar 27, 2025

Uh oh!

mao-sz May 10, 2025

Choose a reason for hiding this comment

Uh oh!

mao-sz commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mao-sz commented Aug 12, 2025

Uh oh!

mao-sz Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Lofty-Brambles commented Nov 17, 2024 •

edited

Loading

mao-sz commented May 11, 2025 •

edited

Loading