Учебное пособие по 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 (или онлайн-версия, postwoman!), Или инструмент командной строки, такой как cURL !.
  2. REST Service : сервер. Существует множество популярных библиотек, которые упрощают создание этих серверов, например ExpressJS для NodeJS и Django для Python.
  3. REST API : определяет конечную точку и методы, которым разрешен доступ / отправка данных на сервер. Подробнее об этом мы поговорим ниже. Другие альтернативы этому: GraphQL, JSON-Pure и oData.

Итак, скажите мне, как выглядит REST?

В очень широком смысле, вы запрашиваете у сервера определенные данные или просите его сохранить некоторые данные, и сервер отвечает на запросы.

С точки зрения программирования, существует конечная точка (URL-адрес), которую сервер ожидает получения запроса. Мы подключаемся к этой конечной точке и отправляем некоторые данные о нас (помните, что REST не имеет состояния, данные о запросе не сохраняются), и сервер отвечает правильным ответом.

Слова скучные, позвольте мне показать вам. Я буду использовать Postman, чтобы показать вам запрос и ответ:

Возвращенные данные находятся в формате JSON (нотация объектов JavaScript) и могут быть доступны напрямую.

Здесь //official-joke-api.appspot.com/random_jokeэто называется конечной точкой API. Сервер будет прослушивать эту конечную точку для запросов, подобных тому, который мы сделали.

Анатомия REST:

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

  1. Конечная точка : Я уже говорил вам об этом. Напоминаем, что это URL-адрес, по которому сервер REST прослушивает.
  2. Метод : Ранее я писал, что вы можете запрашивать данные или изменять их, но как сервер узнает, какую операцию хочет выполнить клиент? REST реализует несколько «методов» для разных типов запросов, из которых наиболее популярны следующие:

    - GET : получить ресурс с сервера.

    - POST : создание ресурса на сервере.

    - PATCH или PUT : обновить существующий ресурс на сервере.

    - УДАЛИТЬ : удалить существующий ресурс с сервера.

  3. Заголовки : дополнительные сведения, предоставляемые для связи между клиентом и сервером (помните, что REST не имеет состояния). Вот некоторые из распространенных заголовков:

    Запрос:

    - host : IP-адрес клиента (или источник запроса)

    - accept-language : язык, понятный клиенту

    - user-agent : данные о клиенте, операционной системе и производителе

    Ответ :

    - status : статус запроса или HTTP-кода.

    - content-type : тип ресурса, отправленного сервером.

    - set-cookie : устанавливает файлы cookie по серверу

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

Довольно подробностей - покажи код.

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

Убедитесь, что у вас установлен Node.JS nodeи npmдоступны на вашем пути. Я буду использовать Node 12.16.2 и NPM 6.14.4.

Создайте каталог rest-service-nodeи cd в него:

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!