- Node.js and Express.
- HTTP methods and status codes.
- Reading Request data from body, URL parameters and query string parameters.
- API design and development.
Use Node.js and Express to build an API that performs CRUD operations on posts
.
This is a two day project.
- Due Monday: the server with the
GET
endpoints. - Due Tuesday: the
POST
,PUT
andDELETE
endpoints.
- Fork and Clone this repository.
- CD into the folder where you cloned the repository.
- Type
yarn
ornpm install
to download all dependencies listed insidepackage.json
.
Database access will be done using the db.js
file included inside the data
folder. This file publishes the following methods:
find()
: calling find returns a promise that resolves to an array of all theposts
contained in the database.findById()
: this method expects anid
as it's only parameter and returns the post corresponding to theid
provided or an empty array if no post with thatid
is found.insert()
: calling insert passing it apost
object will add it to the database and return an object with theid
of the inserted post. The object looks like this:{ id: 123 }
.update()
: accepts two arguments, the first is theid
of the post to update and the second is an object with thechanges
to apply. It returns the count of updated records. If the count is 1 it means the record was updated correctly.remove()
: the remove method accepts anid
as it's first parameter and upon successfully deleting the post from the database it returns the number of records deleted.
Now that we have a way to add, update, remove and retrieve data from the provided database, it is time to work on the API.
- To start the server, type
yarn server
ornpm run server
from the root folder (where the package.json file is). The server is configured to restart automatically as you make changes. - Add the code necessary to implement the API requirements.
- Test the API using Postman as you work through the exercises.
Posts in the database conform to the following structure:
{
title: "The post title", // String, required
contents: "The post contents" // String, required
}
title
is the title of the post, as a String. contents
contains the body
contents of the post, also as a String.
We have provided an index.js
file and a folder called data
. Inside the data
folder we have added a database with some posts already populated that you can use to test your endpoints as you build them.
Server.js already has db.js
required and ready for you to use when building your endpoints.
Configure the API to respond to the following routes:
Method | Endpoint | Description |
---|---|---|
POST | /api/posts | Creates a post using the information sent inside the request body . |
GET | /api/posts | Returns an array of all the post objects contained in the database. |
GET | /api/posts/:id | Returns the post object with the specified id. |
DELETE | /api/posts/:id | Removes the post with the specified id and returns the deleted post object. You may need to make additional calls to the database in order to satisfy this requirement. |
PUT | /api/posts/:id | Updates the post with the specified id using data from the request body . Returns the modified document, NOT the original. |
When the client makes a POST
request to /api/posts
:
-
If the request body is missing the
title
orcontents
property:- cancel the request.
- respond with HTTP status code
400
(Bad Request). - return the following JSON response:
{ errorMessage: "Please provide title and contents for the post." }
.
-
If the information about the post is valid:
- save the new post the the database.
- return HTTP status code
201
(Created). - return the newly created post.
-
If there's an error while saving the post:
- cancel the request.
- respond with HTTP status code
500
(Server Error). - return the following JSON object:
{ error: "There was an error while saving the post to the database" }
.
When the client makes a GET
request to /api/posts
:
- If there's an error in retrieving the posts from the database:
- cancel the request.
- respond with HTTP status code
500
. - return the following JSON object:
{ error: "The posts information could not be retrieved." }
.
When the client makes a GET
request to /api/posts/:id
:
-
If the post with the specified
id
is not found:- return HTTP status code
404
(Not Found). - return the following JSON object:
{ message: "The post with the specified ID does not exist." }
.
- return HTTP status code
-
If there's an error in retrieving the post from the database:
- cancel the request.
- respond with HTTP status code
500
. - return the following JSON object:
{ error: "The post information could not be retrieved." }
.
When the client makes a DELETE
request to /api/posts/:id
:
-
If the post with the specified
id
is not found:- return HTTP status code
404
(Not Found). - return the following JSON object: ``.
- return HTTP status code
-
If there's an error in removing the post from the database:
- cancel the request.
- respond with HTTP status code
500
. - return the following JSON object:
{ error: "The post could not be removed" }
.
When the client makes a PUT
request to /api/posts/:id
:
-
If the post with the specified
id
is not found:- return HTTP status code
404
(Not Found). - return the following JSON object:
{ message: "The post with the specified ID does not exist." }
.
- return HTTP status code
-
If the request body is missing the
title
orcontents
property:- cancel the request.
- respond with HTTP status code
400
(Bad Request). - return the following JSON response:
{ errorMessage: "Please provide title and contents for the post." }
.
-
If there's an error when updating the post:
- cancel the request.
- respond with HTTP status code
500
. - return the following JSON object:
{ error: "The post information could not be modified." }
.
-
If the post is found and the new information is valid:
- update the post document in the database using the new information sent in the
request body
. - return HTTP status code
200
(OK). - return the newly updated post.
- update the post document in the database using the new information sent in the
- Use
create-react-app
to create an application inside the root folder, name itclient
. - From the React application connect to the
/api/posts
endpoint in the API and show the list of posts. - Style the list of posts however you see fit.