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. На тази крайна точка ще има сървър, който слуша за заявки като тази, която направихме.

Анатомия на ПОЧИВКА:

Добре, така че сега знаем, че клиентът може да изиска данни и сървърът ще реагира адекватно. Нека разгледаме по-задълбочено как се формира заявка.

  1. Крайна точка : Вече ви казах за това. За опресняване това е URL адресът, който REST сървърът слуша.
  2. Метод : По-рано писах, че можете или да поискате данни, или да ги модифицирате, но как сървърът ще знае какъв вид операция клиентът иска да извърши? REST реализира множество „методи“ за различни типове заявки, като най-популярни са следните:

    - GET : Вземете ресурс от сървъра.

    - POST : Създаване на ресурс към сървъра.

    - PATCH или PUT : Актуализирайте съществуващия ресурс на сървъра.

    - DELETE : Изтриване на съществуващ ресурс от сървъра.

  3. Заглавки : Допълнителните подробности, предоставени за комуникация между клиент и сървър (не забравяйте, REST е без гражданство). Някои от често срещаните заглавки са:

    Заявка:

    - хост : IP на клиента (или от мястото, откъдето е възникнала заявката)

    - език за приемане : език, разбираем за клиента

    - потребителски агент : данни за клиент, операционна система и доставчик

    Отговор :

    - статус : състоянието на заявката или HTTP кода.

    - content-type : тип ресурс, изпратен от сървър.

    - set-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!