Last Sync: 2022-08-04 14:30:04

This commit is contained in:
tactonbishop 2022-08-04 14:30:04 +01:00
parent 491cb388b4
commit b578ce659a
3 changed files with 85 additions and 4 deletions

View file

@ -45,7 +45,6 @@ const addCourse = async (newCourse) => {
console.error(err);
}
};
addCourse("Biology and Life Sciences");
```
@ -55,4 +54,34 @@ Which returns:
{ id: 4, name: 'Biology and Life Sciences' }
```
The `id` is added by the server, not the client. Having created the new value we add it to our `courses` array. (In reality we would be creating a new entry in a database.) Then we follow the convention of returning the new value back to the client.
The `id` is added by the server, not the client. Having created the new value we add it to our `courses` array. (In reality we would be creating a new entry in a database.) Then we follow the convention of returning the new value back to the client.
## Validation
We should accept alterations to the database that are not first validated. We can use the [Joi validator](/Programming_Languages/NodeJS/REST_APIs/Validation.md) to vet the request:
```js
function validateCourse(course) {
const schema = Joi.object({
name: Joi.string().min(3).required(),
});
const { error } = schema.validate(course);
return error;
}
```
We can then add the validation as part of our general error handling:
```js
app.post('/api/courses', (req, res) => {
const course = {
id: courses.length + 1,
name: req.body.name
}
const { error } = schema.validate(req.body);
if (error) return error.details.map((joiErr) => res.status(400).send(joiErr.message));
courses.push(course);
res.send(course)
})
```

View file

@ -0,0 +1,52 @@
---
tags:
- Programming_Languages
- backend
- node-js
- express
- REST
- apis
---
# Creating a REST API with Node and Express: PUT requests
To demonstrate the handling of PUT requests, we will create a handler that updates an element in the course array, based on its `id` and return the updated entry:
```js
app.put("/api/courses/:id", (req, res) => {
const course = courses.find((c) => c.id === parseInt(req.params.id));
if (!course)
return res.status(404).send("A course with the given ID was not found");
const { error } = validateCourse(req.body);
if (error)
return error.details.map((joiErr) => res.status(400).send(joiErr.message));
course.name = req.body.name;
res.send(course);
});
```
Our request:
```js
const updateCourse = async (courseChange) => {
try {
const resp = await axios.put("http://localhost:3000/api/courses/1", {
name: courseChange.name,
});
console.log(resp.data);
} catch (err) {
console.error(err);
}
};
updateCourse({ name: "A new course" });
```
Returns:
```js
{ id: 1, name: { name: 'A new course' } }
```

View file

@ -14,14 +14,14 @@ One of the most popular schema validators for NodeJS is [joi](https://www.npmjs.
Let's say we have a POST request that expects a single field as the body that must be a string and greater than two characters long. First we define our schema:
````js
```js
const schema = Joi.object({
name: Joi.string().min(3).required(),
});
const { error } = schema.validate(req.body);
````
```
The `schema` variable is an object whose keys should match those of the intended request body. Instead of actual values we provide Joi's in-built validators, concatenated as necessary. We then store the results of the validation in a variable.