Підручник з REST API - виклики клієнта REST, служби REST та API, що пояснюються прикладами коду

Ви ніколи не замислювались, як вхід / реєстрація на веб-сайті працює на задній панелі? Або як, коли ви шукаєте "симпатичних кошенят" на YouTube, ви отримуєте купу результатів і можете відтікати з віддаленої машини?

У цьому посібнику для початківців я проведу вас через процес налаштування RESTful API. Ми розсекретим частину жаргону та подивимося, як ми можемо кодувати сервер у NodeJS. Давайте заглибимось трохи глибше в JavaScript!

Приберіть цей жаргон

Отже, що таке REST? За даними Вікіпедії:

Репрезентативна передача стану ( REST ) - це програмний архітектурний стиль, який визначає набір обмежень, що використовуються для створення веб-служб. Веб-сервіси RESTful дозволяють запитуючим системам отримувати доступ до текстових подань веб-ресурсів та керувати ними за допомогою єдиного та заздалегідь визначеного набору операцій без громадянства.

Давайте демістифікуємо, що це означає (сподіваємось, ви отримали повну форму). REST - це, в основному, набір правил для спілкування між клієнтом та сервером. Існує кілька обмежень щодо визначення REST:

  1. Клієнт-серверна архітектура : користувальницький інтерфейс веб-сайту / програми повинен бути відокремлений від запиту / сховища даних, щоб кожна частина могла масштабуватися окремо.
  2. Безгромадянське : спілкування не повинно мати контексту клієнта, що зберігається на сервері. Це означає, що кожен запит до сервера повинен бути зроблений з усіма необхідними даними, і не слід робити жодних припущень, якщо сервер має дані з попередніх запитів.
  3. Багаторівнева система : клієнт не повинен мати змоги визначити, чи взаємодіє він безпосередньо із сервером або посередником. Ці посередницькі сервери (будь то проксі чи балансири навантаження) забезпечують масштабованість та безпеку базового сервера.

Добре, отже, тепер, коли ви знаєте, що таке RESTful послуги, ось деякі терміни, що використовуються в заголовку:

  1. Клієнт REST : код або програма, яка може отримати доступ до цих служб REST. Ви використовуєте один прямо зараз! Так, браузер може діяти як неконтрольований клієнт REST (веб-сайт обробляє запити браузера). Браузер тривалий час використовував вбудовану функцію під назвою XMLHttpRequest для всіх запитів REST. Але це вдалося досягти FetchAPI, сучасному, обіцянному підходу до запитів. Інші приклади - це бібліотеки коду, такі як axios, superagent і got, або деякі спеціальні програми, такі як Postman (або онлайнова версія, поштарм!), Або інструмент командного рядка, такий як cURL !.
  2. Сервіс REST : сервер. Є багато популярних бібліотек, які роблять створення цих серверів легким, як ExpressJS для NodeJS та Django для Python.
  3. REST API : визначає кінцеву точку та методи, які мають доступ до / передачі даних на сервер. Про це ми докладно поговоримо нижче. Інші альтернативи цьому: GraphQL, JSON-Pure та oData.

Тож скажіть зараз, як виглядає REST?

Дуже широко кажучи, ви запитуєте у сервера певні дані або просите його зберегти деякі дані, і сервер відповідає на запити.

З точки зору програмування, існує кінцева точка (URL), яку сервер чекає, щоб отримати запит. Ми підключаємося до цієї кінцевої точки і надсилаємо деякі дані про нас (пам’ятайте, REST не має стану, дані про запит не зберігаються), і сервер відповідає правильною відповіддю.

Слова нудні, дозвольте провести демонстрацію. Я буду використовувати листоношу, щоб показати вам запит та відповідь:

Повернуті дані знаходяться в JSON (JavaScript Object Notation) і до них можна отримати безпосередній доступ.

Тут //official-joke-api.appspot.com/random_jokeце називається кінцевою точкою API. На цій кінцевій точці буде прослуховуватися сервер для запитів, подібних до того, який ми зробили.

Анатомія REST:

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

  1. Кінцева точка : Я вже говорив вам про це. Для оновлення це URL-адреса, яку слухає сервер REST.
  2. Метод : Раніше я писав, що ви можете або запитувати дані, або змінювати їх, але як сервер знатиме, яку операцію хоче виконати клієнт? REST реалізує кілька "методів" для різних типів запитів, найбільш популярними є такі:

    - GET : Отримати ресурс із сервера.

    - POST : Створення ресурсу для сервера.

    - PATCH або PUT : оновлення наявного ресурсу на сервері.

    - ВИДАЛИТИ : Видалити наявний ресурс із сервера.

  3. Заголовки : Додаткові деталі, передбачені для зв'язку між клієнтом та сервером (пам’ятайте, REST не має статусу держави). Деякі загальні заголовки:

    Запит:

    - хост : IP-адреса клієнта (або звідки надійшов запит)

    - мова прийняття : мова, зрозуміла клієнту

    - user-agent : дані про клієнта, операційну систему та постачальника

    Відповідь :

    - статус : статус запиту або коду HTTP.

    - тип вмісту : тип ресурсу, що надсилається сервером.

    - set-cookie : встановлює файли cookie за сервером

  4. Дані : (також зване тілом або повідомленням) містить інформацію, яку потрібно надіслати на сервер.

Досить деталей - покажіть мені код.

Почнемо кодувати службу REST у Node. Ми будемо реалізовувати все те, що ми дізналися вище. Ми також будемо використовувати ES6 + для написання нашої послуги.

Переконайтеся, що у вас встановлений Node.JS nodeі npmдоступний на вашому шляху. Я буду використовувати Node 12.16.2 та NPM 6.14.4.

Створіть каталог rest-service-nodeі компакт-диск у ньому:

mkdir rest-service-node cd rest-service-node

Ініціалізуйте проект вузла:

npm init -y

-yПрапор пропускає всі питання. Якщо ви хочете заповнити всю анкету, просто запустіть npm init.

Let's install some packages. We will be using the ExpressJS framework for developing the REST Server. Run the following command to install it:

npm install --save express body-parser

What's body-parser there for? Express, by default, is incapable of handling data sent via POST request as JSON. body-parser allows Express to overcome this.

Create a file called server.js and add the following code:

const express = require("express"); const bodyParser = require("body-parser"); const app = express(); app.use(bodyParser.json()); app.listen(5000, () => { console.log(`Server is running on port 5000.`); }); 

The first two lines are importing Express and body-parser.

Third line initializes the Express server and sets it to a variable called app.

The line, app.use(bodyParser.json()); initializes the body-parser plugin.

Finally, we are setting our server to listen on port 5000 for requests.

Getting data from the REST Server:

To get data from a server, we need a GET request. Add the following code before app.listen:

const sayHi = (req, res) => { res.send("Hi!"); }; app.get("/", sayHi);

We have created a function sayHi which takes two parameters req and res (I will explain later) and sends a 'Hi!' as response.

app.get() takes two parameters, the route path and function to call when the path is requested by the client. So, the last line translates to: Hey server, listen for requests on the '/' (think homepage) and call the sayHi function if a request is made.

app.get also gives us a request object containing all the data sent by the client and a response object which contains all the methods with which we can respond to the client. Though these are accessible as function parameters, the general naming convention suggests we name them res for response and req for request.

Enough chatter. Let's fire up the server! Run the following server:

node server.js

If everything is successful, you should see a message on console saying: Server is running on port 5000.

Note: You can change the port to whatever number you want.

Open up your browser and navigate to //localhost:5000/ and you should see something like this:

There you go! Your first GET request was successful!

Sending data to REST Server:

As we have discussed earlier, let's setup how we can implement a POST request into our server. We will be sending in two numbers and the server will return the sum of the numbers. Add this new method below the app.get :

app.post("/add", (req, res) => { const { a, b } = req.body; res.send(`The sum is: ${a + b}`); });

Here, we will be sending the data in JSON format, like this:

{ "a":5, "b":10 }

Let's get over the code:

On line 1, we are invoking the .post() method of ExpressJS, which allows the server to listen for POST requests. This function takes in the same parameters as the .get() method. The route that we are passing is /add, so one can access the endpoint as //your-ip-address:port/add or in our case localhost:5000/add. We are inlining our function instead of writing a function elsewhere.

On line 2, we have used a bit of ES6 syntax, namely, object destructuring. Whatever data we send via the request gets stored and is available in the body of the req object. So essentially, we could've replaced line 2 with something like:

const num1 = req.body.a; const num2 = req.body.b;

On line 3, we are using the send() function of the res object to send the result of the sum. Again, we are using template literals from ES6. Now to test it (using Postman):

So we have sent the data 5 and 10 as a and b using them as the body. Postman attaches this data to the request and sends it. When the server receives the request, it can parse the data from req.body , as we did in the code above. The result is shown below.

Alright, the final code:

const express = require("express"); const bodyParser = require("body-parser"); const app = express(); app.use(bodyParser.json()); const sayHi = (req, res) => { res.send("Hi!"); }; app.get("/", sayHi); app.post("/add", (req, res) => { const { a, b } = req.body; res.send(`The sum is: ${a + b}`); }); app.listen(5000, () => { console.log(`Server is running on port 5000.`); }); 

REST Client:

Okay, we have created a server, but how do we access it from our website or webapp? Here the REST client libraries will come in handy.

We will be building a webpage which will contain a form, where you can enter two numbers and we will display the result. Let's start.

First, let's change the server.js a bit:

const path = require("path"); const express = require("express"); const bodyParser = require("body-parser"); const app = express(); app.use(bodyParser.json()); app.get("/", (req, res) => { res.sendFile(path.join(__dirname, "index.html")); }); app.post("/add", (req, res) => { const { a, b } = req.body; res.send({ result: parseInt(a) + parseInt(b) }); }); app.listen(5000, () => { console.log(`Server is running on port 5000.`); }); 

We imported a new package path, which is provided by Node, to manipulate path cross-platform. Next we changed the GET request on '/' and use another function available in res, ie. sendFile, which allows us to send any type of file as response. So, whenever a person tries to navigate to '/', they will get our index.html page.

Finally, we changed our app.post function to return the sum as JSON and convert both a and b to integers.

Let's create an html page, I will call it index.html, with some basic styling:

     REST Client   * { margin: 0; padding: 0; box-sizing: border-box; } .container { height: 100vh; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; display: flex; flex-direction: column; justify-content: center; align-items: center; } form { display: flex; flex-direction: column; margin-bottom: 20px; } label, input[type="submit"] { margin-top: 20px; } 

Simple POST Form

Number 1: Number 2: Click Add!

Let's add a script tag just before the closing body tag, so we don't need to maintain a .js file. We will begin by listening for the submit event and call a function accordingly:

 document.addEventListener("submit", sendData); 

First we need to prevent page refresh when the 'Add' button is clicked. This can be done using the preventDefault() function. Then, we will get the value of the inputs at that instant:

function sendData(e) { e.preventDefault(); const a = document.querySelector("#num1").value; const b = document.querySelector("#num2").value; }

Now we will make the call to the server with both these values a and b. We will be using the Fetch API, built-in to every browser for this.

Fetch takes in two inputs, the URL endpoint and a JSON request object and returns a Promise. Explaining them here will be out-of-bounds here, so I'll leave that for you.

Continue inside the sendData() function:

fetch("/add", { method: "POST", headers: { Accept: "application/json", "Content-Type": "application/json" }, body: JSON.stringify({ a: parseInt(a), b: parseInt(b) }) }) .then(res => res.json()) .then(data => { const { result } = data; document.querySelector( ".result" ).innerText = `The sum is: ${result}`; }) .catch(err => console.log(err));

First we are passing the relative URL of the endpoint as the first parameter to fetch. Next, we are passing an object which contains the method we want Fetch to use for the request, which is POST in this case.

We are also passing headers, which will provide information about the type of data we are sending (content-type) and the type of data we accept as response (accept).

Next we pass body. Remember we typed the data as JSON while using Postman? We're doing kind of a similar thing here. Since express deals with string as input and processes it according to content-type provided, we need to convert our JSON payload into string. We do that with JSON.stringify(). We're being a little extra cautious and parsing the input into integers, so it doesn't mess up our server (since we haven't implemented any data-type checking).

Finally, if the promise (returned by fetch) resolves, we will get that response and convert it into JSON. After that, we will get the result from the data key returned by the response. Then we are simply displaying the result on the screen.

At the end, if the promise is rejected, we will display the error message on the console.

Here's the final code for index.html:

     REST Client   * { margin: 0; padding: 0; box-sizing: border-box; } .container { height: 100vh; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; display: flex; flex-direction: column; justify-content: center; align-items: center; } form { display: flex; flex-direction: column; margin-bottom: 20px; } label, input[type="submit"] { margin-top: 20px; } 

Simple POST Form

Number 1: Number 2: Click Add! document.addEventListener("submit", sendData); function sendData(e) { e.preventDefault(); const a = document.querySelector("#num1").value; const b = document.querySelector("#num2").value; fetch("/add", { method: "POST", headers: { Accept: "application/json", "Content-Type": "application/json" }, body: JSON.stringify({ a: parseInt(a), b: parseInt(b) }) }) .then(res => res.json()) .then(data => { const { result } = data; document.querySelector( ".result" ).innerText = `The sum is: ${result}`; }) .catch(err => console.log(err)); }

I have spun up a little app on glitch for you to test.

Conclusion:

So in this post, we learnt about REST architecture and the anatomy of REST requests. We worked our way through by creating a simple REST Server that serves GET and POST requests and built a simple webpage that uses a REST Client to display the sum of two numbers.

You can extend this for the remaining types of requests and even implement a full featured back-end CRUD app.

I hope you have learned something from this. If you have any questions, feel free to reach out to me over twitter! Happy Coding!