REST API -opetusohjelma - REST-asiakas, REST-palvelu ja API-puhelut, jotka on selitetty koodiesimerkkien avulla

Oletko koskaan miettinyt, miten sisäänkirjautuminen / rekisteröityminen verkkosivustolla toimii taustalla? Tai miten hakemalla "söpöjä kittejä" YouTubesta saat joukon tuloksia ja pystyt suoratoistamaan etäkoneelta?

Tässä aloittelijan ystävällisessä oppaassa opastan sinut läpi RESTful-sovellusliittymän perustamisen. Poistamme osan ammattikieltä ja katsomme, kuinka voimme koodata palvelimen NodeJS: ssä. Sukelletaan hieman syvemmälle JavaScriptiin!

Ota se ammattikieltä pois

Joten mikä on REST? Wikipedian mukaan:

Esitystilan siirto ( REST ) on ohjelmistoarkkitehtuuri, joka määrittelee joukon rajoituksia, joita käytetään verkkopalvelujen luomiseen. RESTful-verkkopalvelut antavat pyytäville järjestelmille pääsyn ja manipuloivat Web-resurssien tekstimuotoisia esityksiä käyttämällä yhtenäistä ja ennalta määritettyä joukkoa valtiottomia toimintoja

Selvitetään, mitä se tarkoittaa (toivottavasti sait täydellisen lomakkeen). REST on periaatteessa joukko sääntöjä asiakkaan ja palvelimen välisestä viestinnästä. REST-määritelmässä on muutamia rajoituksia:

  1. Asiakas-palvelinarkkitehtuuri : Sivuston / sovelluksen käyttöliittymä tulisi erottaa datapyynnöstä / tallennustilasta, jotta jokainen osa voidaan skaalata erikseen.
  2. Tilattomuus : Viestinnässä ei pitäisi olla asiakasympäristöä palvelimelle. Tämä tarkoittaa sitä, että jokainen palvelimelle lähetetty pyyntö tulee tehdä kaikilla vaadituilla tiedoilla, eikä oletuksia tule tehdä, jos palvelimella on tietoja aikaisemmista pyynnöistä.
  3. Kerroksinen järjestelmä : asiakkaan ei pitäisi voida kertoa, kommunikoiko hän suoraan palvelimen tai jonkin välittäjän kanssa. Nämä välityspalvelimet (olkoon se välityspalvelin tai kuormituksen tasapainottaja) mahdollistavat taustalla olevan palvelimen skaalautuvuuden ja turvallisuuden.

Okei, joten nyt kun tiedät mitä RESTful-palvelut ovat, tässä on joitain otsikossa käytettyjä termejä:

  1. REST Client : koodi tai sovellus, joka voi käyttää näitä REST-palveluja. Käytät yhtä juuri nyt! Kyllä, selain voi toimia hallitsemattomana REST-asiakkaana (verkkosivusto käsittelee selainpyynnöt). Selain käytti pitkään sisäänrakennettua toimintoa nimeltä XMLHttpRequest kaikkiin REST-pyyntöihin. Mutta tämän onnistui FetchAPI, moderni, lupauksiin perustuva lähestymistapa pyyntöihin. Muita esimerkkejä ovat koodikirjastot, kuten axios, superagent ja got tai jotkut erilliset sovellukset, kuten Postman (tai online-versio, postwoman!), Tai komentorivityökalu, kuten cURL !.
  2. REST-palvelu : palvelin. On monia suosittuja kirjastoja, jotka tekevät näiden palvelimien luomisesta helppoa, kuten ExpressJS NodeJS: lle ja Django Pythonille.
  3. REST-sovellusliittymä : tämä määrittelee päätepisteen ja menetelmät, joille voidaan antaa tietoja tai lähettää tietoja palvelimelle. Puhumme tästä yksityiskohtaisesti alla. Muita vaihtoehtoja tälle ovat: GraphQL, JSON-Pure ja oData.

Joten kerro minulle nyt, miltä REST näyttää?

Hyvin laajasti kysyt palvelimelta tiettyjä tietoja tai pyydät tallentamaan joitain tietoja, ja palvelin vastaa pyyntöihin.

Ohjelmoinnin kannalta on olemassa päätepiste (URL), jota palvelin odottaa saadakseen pyynnön. Yhdistämme kyseiseen päätepisteeseen ja lähetämme joitain tietoja meistä (muista, että REST on tilaton, pyyntöä ei ole tallennettu) ja palvelin vastaa oikealla vastauksella.

Sanat ovat tylsiä, haluan antaa sinulle mielenosoituksen. Käytän Postmania näyttämään sinulle pyynnön ja vastauksen:

Palautetut tiedot ovat JSON-muodossa (JavaScript Object Notation) ja niihin pääsee suoraan.

Tässä //official-joke-api.appspot.com/random_jokekutsutaan API: n päätepisteeksi. Palvelin kuuntelee kyseistä päätepistettä tekemiemme kaltaisten pyyntöjen suhteen.

REST: n anatomia:

Selvä, joten nyt tiedämme, että asiakas voi pyytää tietoja ja palvelin reagoi asianmukaisesti. Katsotaanpa syvemmälle, miten pyyntö muodostetaan.

  1. Päätepiste : Olen jo kertonut sinulle tästä. Päivitettäväksi se on URL, jota REST-palvelin kuuntelee.
  2. Menetelmä : Aikaisemmin kirjoitin, että voit joko pyytää tietoja tai muokata niitä, mutta mistä palvelin tietää minkälaisen toiminnan asiakas haluaa suorittaa? REST toteuttaa useita `` menetelmiä '' erityyppisille pyynnöille, seuraavat ovat suosituimpia:

    - GET : Hanki resurssi palvelimelta.

    - POST : Luo resurssi palvelimelle.

    - PATCH tai PUT : Päivitä olemassa oleva resurssi palvelimella.

    - POISTA : Poista olemassa oleva resurssi palvelimelta.

  3. Otsikot : Asiakkaan ja palvelimen välisestä viestinnästä annetut lisätiedot (muista, että REST on valtioton). Jotkut yleisimmistä otsikoista ovat:

    Pyyntö:

    - isäntä : asiakkaan IP-osoite (tai mistä pyyntö on peräisin)

    - Hyväksy-kieli : asiakkaan ymmärtämä kieli

    - käyttäjäagentti : tietoja asiakkaasta, käyttöjärjestelmästä ja toimittajista

    Vastaus :

    - tila : pyynnön tai HTTP-koodin tila.

    - content-type : palvelimen lähettämän resurssin tyyppi.

    - set-cookie : asettaa evästeet palvelimen mukaan

  4. Tiedot : (kutsutaan myös tekstiksi tai viestiksi) sisältää tietoja, jotka haluat lähettää palvelimelle.

Tarpeeksi yksityiskohdista - näytä koodi.

Aloitetaan REST-palvelun koodaus solmussa. Toteutamme kaikki edellä oppimamme asiat. Käytämme myös ES6 +: ta palvelumme kirjoittamiseen.

Varmista, että Node.JS on asennettu nodeja npmovat käytettävissä polullasi. Käytän solmua 12.16.2 ja NPM 6.14.4.

Luo hakemisto rest-service-nodeja cd siihen:

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

Alusta solmuprojekti:

npm init -y

-yLippu ohittaa kaikki kysymykset. Jos haluat täyttää koko kyselylomakkeen, suorita vain 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.

Voit laajentaa tätä muille pyyntötyypeille ja jopa toteuttaa täysin varustellun CRUD-sovelluksen.

Toivon, että olet oppinut jotain tästä. Jos sinulla on kysyttävää, ota rohkeasti yhteyttä minuun Twitterissä! Hyvää koodausta!