מדריך לממשק API של REST - שיחות לקוח, שירות REST ו- API המתקבלות בדוגמאות קוד

תִכנוּת

שאלתם את עצמכם פעם כיצד כניסה / הרשמה לאתר פועלת במערך האחורי? או איך כשאתה מחפש "חתלתולים חמודים" ב- YouTube, אתה משיג תוצאות רבות ומסוגל להזרים ממכונה מרוחקת?

במדריך ידידותי למתחילים זה, אני אלווה אותך בתהליך הגדרת ה- API של RESTful. אנו מסווגים חלק מהז'רגון ונבדוק כיצד אנו יכולים לקודד שרת ב- NodeJS. בואו נצלול קצת יותר לעומק ב- JavaScript!

הסירו את הז'רגון הזה

אז מה זה REST? על פי ויקיפדיה:

העברת מדינה ייצוגית ( REST ) היא סגנון אדריכלי תוכנה המגדיר מערך אילוצים לשימוש ליצירת שירותי אינטרנט. שירותי רשת RESTful מאפשרים למערכות המבקשות לגשת ולבצע מניפולציות טקסטואליות של משאבי אינטרנט באמצעות מערך אחיד ומוגדר מראש של פעולות חסרות מדינה.

בואו נבהיר את המשמעות של המשמעות של זה (אני מקווה שקיבלתם את הטופס המלא). REST הוא בעצם מערכת כללים לתקשורת בין לקוח לשרת. יש הגבלות על ההגדרה של REST:

  1. ארכיטקטורת שרת לקוח : יש להפריד את ממשק המשתמש של האתר / האפליקציה מבקשה / אחסון הנתונים, כך שניתן לשנות את כל החלקים בנפרד.
  2. חוסר מדינה : בתקשורת לא צריך להיות מאוחסן הקשר לקוח בשרת. המשמעות היא שכל בקשה לשרת צריכה להיעשות עם כל הנתונים הנדרשים ואין להניח הנחות אם לשרת יש נתונים מכל בקשות קודמות.
  3. מערכת שכבתית : הלקוח לא אמור לדעת אם הוא מתקשר ישירות עם השרת או עם מתווך כלשהו. שרתי מתווך אלה (בין אם זה Proxy או מאזן עומסים) מאפשרים מדרגיות ואבטחה של השרת הבסיסי.

אוקיי, אז עכשיו שאתה יודע מה הם שירותים RESTful, הנה כמה מהמונחים המשמשים בכותרת:

  1. לקוח REST : קוד או אפליקציה שיכולה לגשת לשירותי REST אלה. אתה משתמש באחד כרגע! כן, הדפדפן יכול לפעול כלקוח REST לא מבוקר (האתר מטפל בבקשות הדפדפן). הדפדפן, במשך זמן רב, השתמש בפונקציה מובנית בשם XMLHttpRequest לכל בקשות ה- REST. אך, זאת הצליחה FetchAPI, גישה מודרנית ומבוססת על הבטחות לבקשות. דוגמאות אחרות הן ספריות קוד כמו axios, superagent and got או כמה יישומים ייעודיים כמו Postman (או גרסה מקוונת, postwoman!), או כלי שורת פקודה כמו 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. יהיה שרת שיקשיב בנקודת הקצה הזו לבקשות כמו שביצענו.

אנטומיה של REST:

בסדר, אז עכשיו אנחנו יודעים שניתן לבקש נתונים על ידי הלקוח והשרת יגיב כראוי. בואו נבדוק עמוק יותר כיצד מגובשת בקשה.

  1. נקודת סיום : כבר סיפרתי לך על זה. לקבלת רענון, זוהי כתובת האתר ששרת REST מאזין.
  2. שיטה : מוקדם יותר כתבתי שאתה יכול לבקש נתונים או לשנות אותם, אבל איך השרת יידע איזה סוג פעולה הלקוח רוצה לבצע? REST מיישם 'שיטות' מרובות עבור סוגים שונים של בקשות, להלן הפופולריות ביותר:

    - קבל : קבל משאבים מהשרת.

    - POST : צור משאב לשרת.

    - PATCH או PUT : עדכן את המשאב הקיים בשרת.

    - DELETE : מחיקת משאב קיים מהשרת.

  3. כותרות : הפרטים הנוספים המסופקים לתקשורת בין לקוח לשרת (זכרו, REST הוא חסר מדינה). כמה מהכותרות הנפוצות הן:

    בַּקָשָׁה:

    - מארח : ה- IP של הלקוח (או שממנו מקור הבקשה)

    - קבל שפה : שפה מובנת על ידי הלקוח

    - user-agent : נתונים אודות לקוח, מערכת הפעלה וספק

    תגובה :

    - סטטוס : סטטוס הבקשה או קוד ה- HTTP.

    - content-type: type of resource sent by server.

    - set-cookie: sets cookies by server

  4. Data: (also called body or message) contains info you want to send to the server.

Enough with the details – show me the code.

Let's begin coding a REST Service in Node. We will be implementing all the things we learnt above. We will also be using ES6+ to write our service in.

Make sure you have Node.JS installed and node and npm are available in your path. I will be using Node 12.16.2 and NPM 6.14.4.

Create a directory rest-service-node and cd into it:

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

Initialize the node project:

npm init -y

The -y flag skips all the questions. If you want to fill in the whole questionnaire, just run 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!