REST API juhendaja - REST-i klient, REST-teenus ja API-kõned, mida on selgitatud koodinäidetega

Kas olete kunagi mõelnud, kuidas veebisaidil sisselogimine / registreerumine tagalas töötab? Või kuidas saate YouTube'is otsides sõna "armsad kiisud" hulga tulemusi ja saate kaugarvutist välja voogesitada?

Selles algajatele mõeldud sõbralikus juhendis tutvustan teid RESTful API seadistamise protsessiga. Võtame osa žargooni salastatuse kategooriasse ja uurime, kuidas saaksime NodeJS-is serverit kodeerida. Sukeldume JavaScripti natuke sügavamale!

Võtke see žargoon minema

Mis on REST? Vikipeedia andmetel:

Esitusseisundi ülekandmine ( REST ) on tarkvara arhitektuuristiil, mis määratleb veebiteenuste loomisel kasutatavate piirangute kogumi. RESTful veebiteenused võimaldavad taotlevatel süsteemidel pääseda juurde ja käsitseda veebiressursside tekstiesitlusi, kasutades ühtset ja eelnevalt määratletud kodakondsuseta operatsioonide komplekti

Demonstreerime, mida see tähendab (loodetavasti saite täieliku vormi). REST on põhimõtteliselt kliendi ja serveri vahelise suhtluse reeglistik. REST-i määratlusel on mõned piirangud:

  1. Kliendi-serveri arhitektuur : veebisaidi / rakenduse kasutajaliides peaks olema eraldatud andmepäringust / salvestusruumist, nii et iga osa saab skaleerida eraldi.
  2. Kodakondsusetus : suhtlusel ei tohiks olla serverisse salvestatud kliendi konteksti. See tähendab, et iga päring serverile tuleks esitada koos kõigi nõutavate andmetega ja mingeid eeldusi ei tohiks teha, kui serveril on varasemate päringute andmeid.
  3. Kihiline süsteem : klient ei peaks suutma öelda, kas ta suhtleb otse serveri või mõne vahendajaga. Need vahendusserverid (olgu selleks puhverserver või koormuse tasakaalustajad) võimaldavad aluseks oleva serveri mastaapsust ja turvalisust.

Okei, nii et nüüd, kui teate, mis on RESTful teenused, on siin mõned pealkirjas kasutatud terminid:

  1. REST Client : kood või rakendus, mis pääseb nendele REST-teenustele juurde. Kasutate ühte praegu! Jah, brauser võib toimida kontrollimatu REST-kliendina (veebisait haldab brauseri taotlusi). Brauser kasutas pikka aega kõigi REST-päringute jaoks sisseehitatud funktsiooni XMLHttpRequest. Kuid see õnnestus FetchAPI abil, mis on kaasaegne lubadustel põhinev lähenemisviis taotlustele. Teised näited on koodikogud nagu axios, superagent ja got või mõni spetsiaalne rakendus nagu Postman (või veebiversioon, postinaine!) Või käsurea tööriist nagu cURL!
  2. REST-teenus : server. Seal on palju populaarseid raamatukogusid, mis muudavad nende serverite loomise imelihtsaks, näiteks ExpressJS NodeJS ja Django Pythoni jaoks.
  3. REST API : see määratleb lõpp-punkti ja meetodid, mis võimaldavad serverile andmetele juurde pääseda / neile esitada. Sellest räägime allpool väga üksikasjalikult. Muud alternatiivid sellele on: GraphQL, JSON-Pure ja oData.

Nii et ütle mulle nüüd, kuidas REST välja näeb?

Väga laias laastus küsite serverilt teatud andmeid või palute mõned andmed salvestada ja server vastab päringutele.

Programmeerimise mõttes on olemas lõpp-punkt (URL), mida server ootab päringu saamiseks. Ühendame selle lõpp-punktiga ja saadame mõned andmed meie kohta (pidage meeles, et REST on kodakondsuseta, päringu kohta pole andmeid salvestatud) ja server vastab õige vastusega.

Sõnad on igavad, lubage mul teha teile demonstratsioon. Kasutan Postmanit, et näidata teile taotlust ja vastust:

Tagastatud andmed on JSON-is (JavaScripti objektide märge) ja neile pääseb otse juurde.

Siin //official-joke-api.appspot.com/random_jokenimetatakse seda API lõpp-punktiks. Sellel lõpp-punktil kuulab server selliseid päringuid nagu meie tegime.

Puhkuse anatoomia:

Hästi, nii et nüüd teame, et klient võib andmeid küsida ja server reageerib asjakohaselt. Vaatame sügavamalt, kuidas taotlus moodustub.

  1. Lõpp-punkt : ma olen sellest teile juba rääkinud. Värskenduseks on see URL, kus REST-server kuulab.
  2. Meetod : Varem kirjutasin, et võite andmeid küsida või neid muuta, kuid kuidas saab server teada, millist operatsiooni klient soovib teha? REST rakendab erinevat tüüpi päringute jaoks mitut meetodit, kõige populaarsemad on järgmised:

    - GET : hankige ressurss serverilt.

    - POST : Looge serverile ressurss.

    - PATCH or PUT : värskendage serveris olemasolevat ressurssi.

    - KUSTUTA : olemasoleva ressursi kustutamine serverist.

  3. Päised : kliendi ja serveri vahelise suhtluse jaoks ette nähtud täiendavad üksikasjad (pidage meeles, et REST on kodakondsuseta). Mõned levinud päised on:

    Taotlus:

    - host : kliendi IP (või päringu päritolu)

    - aktsepteerimiskeel : kliendile arusaadav keel

    - kasutajaagent : andmed kliendi, operatsioonisüsteemi ja hankija kohta

    Vastus :

    - status : päringu või HTTP-koodi olek.

    - content-type : serveri saadetud ressursi tüüp.

    - seatud küpsis : määrab küpsised serveri kaupa

  4. Andmed : (nimetatakse ka kehaks või sõnumiks) sisaldab teavet, mille soovite serverile saata.

Piisab üksikasjadest - näita mulle koodi.

Alustame REST-teenuse kodeerimist sõlmes. Rakendame kõik eespool õpitud asjad. Kasutame teenuse kirjutamiseks ka ES6 + -i.

Veenduge, et olete Node.JS paigaldatud ja nodening npmon saadaval oma teed. Kasutan sõlme 12.16.2 ja NPM 6.14.4.

Looge kataloog rest-service-nodeja sinna CD:

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

Alustage sõlme projekti:

npm init -y

-yLipu ignoreerib kõikidele küsimustele. Kui soovite täita kogu küsimustiku, siis lihtsalt kandideerige 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.

Saate seda laiendada ülejäänud päringutüüpide jaoks ja isegi rakendada täisfunktsionaalset CRUD-i tagavararakendust.

Loodan, et olete sellest midagi õppinud. Kui teil on küsimusi, pöörduge julgelt Twitteri poole! Head kodeerimist!