Topics:
- Client and server
- Node.js and Express
- HTTP requests and responses
- HTTP headers and status codes
- Request parameters
- API design and development
You've been focusing on client-side JavaScript thus far, but now you'll make the transition to server-side. The goal here is to handle requests from the client and deliver back responses. You'll develop an API to allow you to create, read, update, and delete posts, as if you were making an application like Facebook or Twitter.
- Run
npm install
to download the dependencies. - To test your application in your browser, or by using
Postman, make sure you've installed
nodemon
vianpm install -g nodemon
and then runnodemon src/app.js
.nodemon
will keep the server running and automatically restart it if you change anything. You can now make requests tohttp://localhost:3000
in your browser or Postman! - Make modifications to
src/server.js
and test it with Postman.
You'll create an API that allows the client to create, read, update, and delete posts. The posts will be maintained in memory as a JavaScript array. Each post is an object in the array of the following form:
{
title: "The post title",
contents: "The post contents"
}
title
is the title of the post, as a String. contents
contains the body
contents of the post, also as a String.
There are five main route handlers that will allow the client to read/modify the array.
When the client makes a GET
request to /posts
:
-
If the client provides the query-string parameter
term
, filter the posts to those that have theterm
in theirtitle
orcontents
(or both), and send down those posts in a JSON response. -
Otherwise, send down the full array of posts as a JSON response.
When the client makes a POST
request to /posts
:
-
Ensure that the client provides both
title
andcontents
in the request body. If any of these don't exist, send an object of the form{ error: "Error message" }
as a JSON response. Make sure to respond with an appropriate status code. -
If all fields are provided, create a new post object. Assign the post a unique, numeric
id
property that will act as its identifier, and add it to the posts array. Return the newly created post object, with its assignedid
, to the client in a JSON response.
When the client makes a PUT
request to /posts
:
-
Ensure that the client provides
id
,title
, andcontents
in the request body. If any of these don't exist, send an object of the form{ error: "Error message" }
as a JSON response. Make sure to respond with an appropriate status code. -
If the
id
doesn't correspond to a valid post, respond with an error in the same form as above. -
Modify the post with the given
id
, updating itstitle
andcontents
. Respond with the newly updated post object in a JSON response.
When the client makes a DELETE
request to /posts
:
-
Ensure that the client provides an
id
in the request body, and that theid
corresponds to a valid post. If there's an error, send an object of the form{ error: "Error message" }
as a JSON response. Make sure to respond with an appropriate status code. -
Remove the post with the given
id
from the array of posts. Return the object{ success: true }
in a JSON response.
If you finish up this lab early, take this opportunity to access a public API. Some good ones include Twitter, Facebook, SendGrid, IBM Watson, IMDB, the Star Wars API etc. Choose one that gives you access to data or functionality that you're interested in. Figure out how to get an access token to that API, and how to use that token to authenticate requests from a node server. Use the request node.js library to request data from your API of choice. Once you successfully grab some data back from your API of choice, maybe render it in a React application. Be creative here and have fun!