Водич за РЕСТ АПИ - РЕСТ клијент, РЕСТ услуга и АПИ позиви објашњени примерима кода

Да ли сте се икад запитали како пријава / регистрација на веб локацији функционише на позадини? Или како када тражите „слатке маце“ на ИоуТубеу, добијете гомилу резултата и можете да стримујете са удаљене машине?

У овом водичу прилагођеном почетницима, водићу вас кроз поступак подешавања РЕСТфул АПИ-ја. Декласификоваћемо неке од жаргона и погледати како можемо кодирати сервер у НодеЈС. Заронимо мало дубље у ЈаваСцрипт!

Склони тај жаргон

Па, шта је РЕСТ? Према Википедији:

Репрезентативни пренос стања ( РЕСТ ) је софтверски архитектонски стил који дефинише скуп ограничења која ће се користити за стварање веб услуга. Веб услуге РЕСТфул омогућавају системима који захтевају приступ приступу и манипулацији текстуалним приказима веб ресурса коришћењем јединственог и унапред дефинисаног скупа операција без држављанства.

Демистификујмо шта то значи (надамо се да сте добили пуни образац). РЕСТ је у основи скуп правила за комуникацију између клијента и сервера. Постоји неколико ограничења у дефиницији РЕСТ-а:

  1. Клијент-сервер архитектура : кориснички интерфејс веб странице / апликације треба да буде одвојен од захтева / складиштења података, тако да се сваки део може појединачно скалирати.
  2. Апатридност : комуникација не би требало да има контекст клијента ускладиштен на серверу. То значи да сваки захтев серверу треба да се поднесе са свим потребним подацима и да се не предузимају претпоставке ако сервер има податке из претходних захтева.
  3. Слојевити систем : клијент не би требало да зна да ли комуницира директно са сервером или неким посредником. Ови посреднички сервери (било да су то проки или балансери оптерећења) омогућавају скалабилност и сигурност основног сервера.

Добро, сад кад знате шта су РЕСТфул услуге, ево неких термина који се користе у наслову:

  1. РЕСТ клијент : код или апликација која може да приступи овим РЕСТ услугама. Тренутно користите један! Да, прегледач може да делује као неконтролисани РЕСТ клијент (веб локација обрађује захтеве прегледача). Прегледач је дуго користио уграђену функцију која се назива КСМЛХттпРекуест за све РЕСТ захтеве. Али, ово је наследио ФетцхАПИ, модеран приступ захтевима заснован на обећањима. Други примери су библиотеке кода као што су акиос, суперагент и гот или неке наменске апликације попут Постман (или мрежна верзија, поштарка!) Или алат за командну линију попут цУРЛ !.
  2. РЕСТ Сервице : сервер. Постоје многе популарне библиотеке које стварају ове сервере као да је лако, попут ЕкпрессЈС за НодеЈС и Дјанго за Питхон.
  3. РЕСТ АПИ : ово дефинише крајњу тачку и методе којима је дозвољен приступ / предаја података серверу. О томе ћемо врло детаљно говорити у наставку. Остале алтернативе овоме су: ГрапхКЛ, ЈСОН-Пуре и оДата.

Па реците ми сада, како изгледа РЕСТ?

У најширем смислу, тражите од сервера одређене податке или тражите да сачува неке податке, а сервер одговара на захтеве.

У програмском смислу, постоји крајња тачка (УРЛ) коју сервер чека да добије захтев. Повезујемо се са том крајњом тачком и шаљемо неке податке о нама (запамтите, РЕСТ је без држављанства, подаци о захтеву се не чувају) и сервер одговара тачним одговором.

Речи су досадне, даћу вам демонстрацију. Користићу поштара да вам покажем захтев и одговор:

Враћени подаци су у ЈСОН-у (ЈаваСцрипт Објецт Нотатион) и може им се директно приступити.

Овде //official-joke-api.appspot.com/random_jokeсе назива крајња тачка АПИ-ја. На тој крајњој тачки ће бити послужитељ сервера за захтеве попут овог који смо ми упутили.

Анатомија ОДМОРА:

У реду, сада знамо да клијент може тражити податке, а сервер ће одговорити на одговарајући начин. Погледајмо дубље како се формира захтев.

  1. Крајња тачка : Већ сам вам рекао о овоме. За освежавање је УРЛ адреса на којој РЕСТ сервер слуша.
  2. Метод : Раније сам писао да можете или захтевати податке или их мењати, али како ће сервер знати какву операцију клијент жели да изврши? РЕСТ примењује више „метода“ за различите типове захтева, а најпопуларнији су следећи:

    - ГЕТ : Набавите ресурсе са сервера.

    - ПОСТ : Направите ресурс за сервер.

    - ПАТЦХ или ПУТ : Ажурирајте постојећи ресурс на серверу.

    - ДЕЛЕТЕ : Избришите постојећи ресурс са сервера.

  3. Заглавља : Додатни детаљи предвиђени за комуникацију између клијента и сервера (не заборавите, РЕСТ нема држављанство). Нека од уобичајених заглавља су:

    Захтев:

    - хост : ИП клијента (или одакле је захтев потекао)

    - језик прихватања : језик који клијент разуме

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

    Одговор :

    - статус : статус захтева или ХТТП кода.

    - цонтент-типе : врста ресурса коју шаље сервер.

    - сет-цоокие : поставља колачиће по серверу

  4. Подаци : (такође се назива тело или порука) садржи информације које желите да пошаљете серверу.

Доста са детаљима - покажи ми шифру.

Почнимо са кодирањем РЕСТ услуге у Нодеу. Спровешћемо све ствари које смо горе научили. Такође ћемо користити ЕС6 + за писање наше услуге.

Уверите се да имате Ноде.јс инсталиран и nodeи npmдоступни су на свом путу. Користићу Ноде 12.16.2 и НПМ 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.

Можете да проширите ово на преостале типове захтева, па чак и да примените потпуно опремљену позадинску ЦРУД апликацију.

Надам се да сте из овога нешто научили. Ако имате било каквих питања, слободно ме контактирајте путем твиттер-а! Срећно кодирање!