Створіть API Node.js менш ніж за 30 хвилин

Створіть API Node.js менш ніж за 30 хвилин

Node.js може залякувати початківців. Але його гнучка структура та відсутність суворих вказівок робить її більш складною, ніж вона є.

Цей підручник - це короткий та простий посібник із Node.js, фреймворку Express та MongoDB, який фокусується на основних маршрутах REST та базовій взаємодії з базою даних. Ви створите простий шаблонний шаблон API, який потім можна використовувати як основу для будь-якої програми.

Для кого призначений цей підручник : Ви повинні добре знати API REST та операції CRUD, а також базові знання JavaScript. Я використовую ES6 (в основному функції стрілки жиру), але нічого надто складного.

У цьому навчальному посібнику ви створите каркас бек-енду для програми для створення нотаток - думаю, Google Keep. Ви хочете мати можливість виконувати всі чотири дії CRUD у своїх нотатках: створювати, читати, оновлювати та видаляти.

Налаштовуючи

Якщо у вас не встановлено Node, дивіться тут.

У новому каталозі запустіть npm init і дотримуйтесь вказівок, даючи своєму додатку ім'я "помітний" (або інше, що вам може сподобатися).

npm init

Після цього у вас повинен бути готовий пакет package.json до вашого каталогу. Це означає, що ви можете розпочати встановлення залежностей, необхідних для вашого проекту.

Ви збираєтеся використовувати Express як свій фреймворк, MongoDB як базу даних і пакет, який називається body-parser, щоб допомогти обробляти запити JSON.

npm install --save express [email protected] body-parser

Я також настійно рекомендую встановлювати Nodemon як залежність розробника. Це простий маленький пакет, який автоматично перезапускає ваш сервер при зміні файлів.

Якщо ви біжите:

npm install --save-dev nodemon

Потім ви можете додати наступний сценарій до package.json :

// package.json
 "scripts": { "dev": "nodemon server.js" },

Ваш повний пакет.json повинен виглядати так:

// package.json
{ "name": "notable", "version": "1.0.0", "description": "", "main": "server.js", "scripts": { "dev": "nodemon server.js" }, "author": "", "license": "ISC", "dependencies": { "body-parser": "^1.15.2", "express": "^4.14.0", "mongodb": "^2.2.16" }, "devDependencies": { "nodemon": "^1.11.0" }}

Тепер ви можете створити файл server.jsі починайте будувати свій API.

Наш сервер

Почнемо з того, що нам потрібні всі ваші залежності в server.js.

// server.js
const express = require('express');const MongoClient = require('mongodb').MongoClient;const bodyParser = require('body-parser');
const app = express();

Ви збираєтеся використовувати MongoClient для взаємодії з вашою базою даних. Зверніть увагу, що ви також ініціалізуєте свій додаток як екземпляр Express, вашого фреймворку.

Останнє, що вам потрібно зробити, щоб ваш сервер працював, - це сказати своєму додатку почати слухати запити HTTP.

Ви можете вказати порт і розпочати прослуховування так:

// server.js
const port = 8000;
app.listen(port, () => { console.log('We are live on ' + port);});

Тепер, якщо ви запустите npm run dev (або node server.js, якщо ви не встановили Nodemon), ви повинні побачити в терміналі «Ми живемо на порту 8000».

Ваш сервер працює. Але це не робить багато. Або що-небудь, насправді.

Давайте це виправимо.

CRUDdy маршрути

У цьому прикладі потрібно побудувати 4 маршрути; СТВОРИТИ нотатку, ЧИТАТИ нотатки, ОНОВИТИ нотатку та ВИДАЛИТИ нотатку.

Це дасть вам хороше уявлення про те, як структурувати майже будь-який основний маршрут за допомогою Node.

Однак для тестування вашого API потрібно імітувати клієнтську сторону, яка робить запити. Для цього ви будете використовувати чудовий додаток під назвою «Листоноша». Це дозволяє робити прості запити HTTP із власними тілами та параметрами.

Встановіть «Листоноша», і ми почнемо налаштовувати ваші маршрути.

Супер організовано

Більшість підручників з Node.js (і багатьох реальних додатків) розміщують усі свої маршрути в одному великому файлі routes.js . Це робить мене трохи незручним. Навпаки, розподіл ваших файлів на окремі папки призводить до хорошої читабельності та робить великі програми більш керованими.

У вас немає великого додатка, але давайте зробимо це правильно. Виконайте наступні каталоги: додаток папка з маршрутами папки всередині неї, з index.js і note_routes.js файлом всередині нього.

Іншими словами: root> app> routes> index.js та note_routes.js.

mkdir appcd appmkdir routescd routestouch index.jstouch note_routes.js

Ці каталоги можуть здатися надмірними для вашого простого невеликого додатка, але завжди добре починати з найкращих практик.

Ваш перший маршрут

Почнемо з C у CRUD-create. Як би ви створили нотатку?

Well, before you do that, you have to build a bit more infrastructure. In Express, routes are wrapped in a function, which takes the Express instance and a database as arguments.

Like this:

// routes/note_routes.js
module.exports = function(app, db) {
};

You can then export this function through your index.js:

// routes/index.js
const noteRoutes = require('./note_routes');
module.exports = function(app, db) { noteRoutes(app, db); // Other route groups could go here, in the future};

Then import it for use in server.js:

// server.js
const express = require('express');const MongoClient = require('mongodb').MongoClient;const bodyParser = require('body-parser');
const app = express();
const port = 8000;
require('./app/routes')(app, {});app.listen(port, () => { console.log('We are live on ' + port);});

Note that since you don’t have a database yet set up, you’re just passing in an empty object.

Okay, now you can make your CREATE route.

The syntax is simple:

// note_routes.js
module.exports = function(app, db) { app.post('/notes', (req, res) => { // You'll create your note here. res.send('Hello') });};

When the app receives a post request to the ‘/notes’ path, it will execute the code inside the callback- passing in a request object (which contains the parameters or JSON of the request) and a response object (used to reply).

You can test this by using Postman to send a POST request to localhost:8000/notes.

Nice! You created your first real route.

Next step is to add some parameters to your request and process them in your API and, finally, add in your database.

Request Parameters

In Postman, go to the Body tab and add some key-value pairs, after selecting the x-www-form-urlencoded radio button.

This will add encoded form data to your request, which you’ll be able to process with your API.

Now in your note_routes.js, let’s just log out the body.

// note_routes.js
module.exports = function(app, db) { app.post('/notes', (req, res) => { console.log(req.body) res.send('Hello') });};

Try sending the Postman request and you’ll see… undefined.

Unfortunately, Express can’t process URL encoded forms on its own. But you did install that body-parser package…

// server.
const express = require('express');const MongoClient = require('mongodb').MongoClient;const bodyParser = require('body-parser');
const app = express();
const port = 8000;
app.use(bodyParser.urlencoded({ extended: true }));
require('./app/routes')(app, {});app.listen(port, () => { console.log('We are live on ' + port);});

Now you should see the body as an object in the terminal.

{ title: 'My Note Title', body: 'What a great note.' }

Last step to your preliminary route: set up the database, and then add your data in.

The easiest way to set up a Mongo database is through mLab: it’s free for the smallest size, and quite fast to setup.

Once you create an account and a MongoDB deployment, add a user to the database with a username and password:

then grab the URL here (the second one):

And in a directory config in the root of your project, create a db.js file.

mkdir config cd configtouch db.js

Inside, add the URL:

module.exports = { url : YOUR URL HERE};

Don’t forget to add your username and password (the ones from the database user, not your mLab account) into the URL. (If you’re committing this project to Github, be sure to include a .gitignore file like so, so you don’t share your password with everyone.)

Now in your server.js, you can use the MongoClient to connect to your DB, and use this to wrap your app setup:

// server.js
const express = require('express');const MongoClient = require('mongodb').MongoClient;const bodyParser = require('body-parser');const db = require('./config/db');
const app = express();
const port = 8000;
app.use(bodyParser.urlencoded({ extended: true }));
MongoClient.connect(db.url, (err, database) => { if (err) return console.log(err) require('./app/routes')(app, database);
 app.listen(port, () => { console.log('We are live on ' + port); }); })

If you’re using the latest version of the MongoDB (3.0+), modify it like so:

// server.js
const express = require('express');const MongoClient = require('mongodb').MongoClient;const bodyParser = require('body-parser');const db = require('./config/db');
const app = express();
const port = 8000;
app.use(bodyParser.urlencoded({ extended: true }));
MongoClient.connect(db.url, (err, database) => { if (err) return console.log(err) // Make sure you add the database name and not the collection name const database = database.db("note-api") require('./app/routes')(app, database);
 app.listen(port, () => { console.log('We are live on ' + port); }); })

(Thanks to Alex Stroulger for the fix for 3.0)

That’s the last of your infrastructure setup! It’s all route-building from here.

Adding to your Database

MongoDB stores data in collections- which are exactly how they sound. In your case, you want to store your notes in a collection called — you guessed it — notes.

Since you pass in your database as the db argument in your routes, you can then access it like so:

db.collection('notes')

Creating a note is as simple as calling insert on your collection:

const note = { text: req.body.body, title: req.body.title} db.collection('notes').insert(note, (err, results) => {}

Once the insert is complete (or has failed for whatever reason), you want to either send back an error or send back the newly created note object. Here’s the full note_routes.js:

// note_routes.js
module.exports = function(app, db) { const collection = app.post('/notes', (req, res) => { const note = { text: req.body.body, title: req.body.title }; db.collection('notes').insert(note, (err, result) => { if (err) { res.send({ 'error': 'An error has occurred' }); } else { res.send(result.ops[0]); } }); });};

Try it out! Send an x-www-form-urlencoded POST request with Postman, with a title and body set under the Body tab.

The response should look like this:

If you log into mLab, you should also see the created note in the database.

Your READ Route

Now you can pick up the pace a bit.

Say you wanted to get back the note you just created, by navigating to localhost:8000/notes/{the id}. In this case, that would be localhost:8000/notes/585182bd42ac5b07a9755ea3.

(If you don’t have the ID for one of your notes, you can check on mLab or just create a new one).

Here’s what this would look like in note_routes.js:

// note_routes.js
module.exports = function(app, db) { app.get('/notes/:id', (req, res) => { });
 app.post('/notes', (req, res) => { const note = { text: req.body.body, title: req.body.title }; db.collection('notes').insert(note, (err, result) => { if (err) { res.send({ 'error': 'An error has occurred' }); } else { res.send(result.ops[0]); } }); });};

Just like before, you’re going to call a method on your database collection of notes. Here, it’s the aptly named findOne.

// note_routes.js
module.exports = function(app, db) { app.get('/notes/:id', (req, res) => { const details = { '_id':  }; db.collection('notes').findOne(details, (err, item) => { if (err) { res.send({'error':'An error has occurred'}); } else { res.send(item); } }); });
app.post('/notes', (req, res) => { const note = { text: req.body.body, title: req.body.title }; db.collection('notes').insert(note, (err, result) => { if (err) { res.send({ 'error': 'An error has occurred' }); } else { res.send(result.ops[0]); } }); });};

You can grab the id from the URL parameters via req.params.id. However, if you try to just plop in the string into the above, it won’t work.

MongoDB requires not just an ID as a string, but as an ID object or, as they call it, an ObjectID.

Don’t worry, it’s an easy fix. Here’s the full code:

// note_routes.js
var ObjectID = require('mongodb').ObjectID;
module.exports = function(app, db) { app.get('/notes/:id', (req, res) => { const id = req.params.id; const details = { '_id': new ObjectID(id) }; db.collection('notes').findOne(details, (err, item) => { if (err) { res.send({'error':'An error has occurred'}); } else { res.send(item); } }); });
app.post('/notes', (req, res) => { const note = { text: req.body.body, title: req.body.title }; db.collection('notes').insert(note, (err, result) => { if (err) { res.send({ 'error': 'An error has occurred' }); } else { res.send(result.ops[0]); } }); });};

Try it out with one of your note ID’s, and it should look like this:

Your DELETE Route

Deleting an object is actually pretty much the same as finding an object. You just use the remove function instead of the findOne. Here’s the full code. I’ve highlighted what’s different from your GET:

// note_routes.js
// ...
 app.delete('/notes/:id', (req, res) => { const id = req.params.id; const details = { '_id': new ObjectID(id) }; db.collection('notes').remove(details, (err, item) => { if (err) { res.send({'error':'An error has occurred'}); } else { res.send('Note ' + id + ' deleted!'); } }); });
// ...

Your UPDATE Route

Last one! The PUT is basically a hybrid between READ and CREATE. You find the object, then update it accordingly. If you deleted your only note, time to make another one!

The code:

// note_routes.js
// ...
 app.put('/notes/:id', (req, res) => { const id = req.params.id; const details = { '_id': new ObjectID(id) }; const note = { text: req.body.body, title: req.body.title }; db.collection('notes').update(details, note, (err, result) => { if (err) { res.send({'error':'An error has occurred'}); } else { res.send(note); } }); });
// ...

Now you can update any of your notes, like so:

Note the imperfection with this code- if you fail to supply a body or title, the PUT request will nullify those fields on the note in the database.

You could easily add some conditional logic to update the fields only if they’re present in the request- I left that out just to keep it simple.

API Complete

That’s it! You have a working Node API with each of the four major CRUD operations.

The goal of this tutorial was to give you a degree of familiarity with Express, Node, and MongoDB — you can use your simple app as a launching pad for more complex projects.

In the future I’ll be writing tutorials to create more simple API’s in different languages and frameworks. Hit the follow button if you’re interested!

If this tutorial was any help to you, please hit the green heart below- it means a lot. Feel free to also leave me a comment with any feedback or questions.

Thanks for reading!