Η πραγματοποίηση μιας κλήσης API εντός του VS Code είναι παιχνιδάκι, απλώς εγκαταστήστε μία επέκταση και, στη συνέχεια, δεν θα χρειαστεί να βασιστείτε σε κανένα εξωτερικό εργαλείο για να ολοκληρώσετε τη δουλειά.

Κατά τη διάρκεια της ανάπτυξης, είναι σύνηθες να κάνετε αιτήματα σε API. Αυτό μπορεί να αφορά κάποιο εξωτερικό API ή το API του διακομιστή υποστήριξης.

Μπορείτε να χρησιμοποιήσετε εργαλεία τρίτων, όπως ο Ταχυδρόμος για να πραγματοποιήσετε τις κλήσεις σας API. Ωστόσο, μια επέκταση κώδικα VS σάς επιτρέπει να πραγματοποιείτε κλήσεις API απευθείας από τον κώδικα VS. Εδώ, θα μάθετε πώς να εκτελείτε αιτήματα API στο VS Code.

Η επέκταση πελάτη VS Code REST

Μια επέκταση στο VS Code είναι μια προσθήκη ή ένα πρόσθετο που βελτιώνει τις λειτουργίες του προγράμματος επεξεργασίας κώδικα του Visual Studio. Η αγορά επεκτάσεων VS Code παρέχει διάφορους τύπους επεκτάσεων που μπορούν να σας βοηθήσουν με τις εργασίες προγραμματισμού σας. Υπάρχει μια επέκταση για την προσθήκη υποστήριξης γλώσσας. Υπάρχει ένα για την παροχή αυτόματης συμπλήρωσης για μια συγκεκριμένη γλώσσα προγραμματισμού και ούτω καθεξής.

instagram viewer
Οι επεκτάσεις διευκολύνουν τον προγραμματισμό με VS Code.

Η επέκταση REST Client σάς επιτρέπει να εκτελείτε αιτήματα API μέσα από τον κώδικα VS. Η επέκταση περιλαμβάνει τον επεξεργαστή REST API, μια οπτική διεπαφή που σας επιτρέπει να υποβάλετε ερωτήματα στα τελικά σημεία του API. Δέχεται προσαρμοσμένες κεφαλίδες, παραμέτρους ερωτήματος και ορισμένες άλλες παραμέτρους.

Για να εγκαταστήσετε το Πελάτης REST, ανοίξτε το VS Code και κάντε κλικ στο Επεκτάσεις αυτί. Ψάχνω για Πελάτης REST και κάντε κλικ στο Εγκαθιστώ κουμπί για να το προσθέσετε στον κώδικα VS.

Σύμφωνα με το Λεπτομέριες καρτέλα, θα βρείτε έναν χρήσιμο οδηγό σχετικά με τον τρόπο χρήσης του προγράμματος-πελάτη για την υποβολή αιτημάτων API. Ας δούμε τους τέσσερις συνήθεις τύπους αιτημάτων και πώς να τα κάνετε χρησιμοποιώντας την επέκταση REST Client.

Θα χρησιμοποιήσουμε JSONPlaceholder για να επιδείξετε την πραγματοποίηση κλήσεων API χρησιμοποιώντας την επέκταση REST Client. Παρέχει έξι κοινούς πόρους που μπορείτε να διαβάσετε, να επεξεργαστείτε, να ενημερώσετε ή να διαγράψετε κάνοντας αιτήματα API.

Υποβολή αιτήματος GET χρησιμοποιώντας την επέκταση πελάτη REST

Ξεκινήστε δημιουργώντας ένα .http αρχείο για τα αιτήματά σας API. Μπορείτε να ονομάσετε το αρχείο τα αιτήματά μου.http.

Προσθέστε τον παρακάτω κώδικα στο δικό σας τα αιτήματά μου.http αρχείο για την ανάκτηση ενός πόρου από το JSONPlaceholder API με 1 ως αναγνωριστικό:

ΠΑΙΡΝΩ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Για να στείλετε το αίτημα, κάντε κλικ στο Στείλε αίτημα κουμπί που εμφανίζεται στην κορυφή του αρχείου. Θα ανοίξει ένα νέο παράθυρο που περιέχει τις λεπτομέρειες της απάντησης.

Αυτός είναι ο τρόπος με τον οποίο κάνετε ένα αίτημα GET μέσα στον Κώδικα VS.

Υποβολή αιτήματος POST με χρήση της επέκτασης πελάτη REST

Κάνετε ένα αίτημα POST όταν θέλετε να δημοσιεύσετε δεδομένα στον διακομιστή, συνήθως για να δημιουργήσετε έναν νέο πόρο.

Για να δημιουργήσετε έναν νέο πόρο στο JSONPlaceholder API, αντικαταστήστε τον κώδικα στο δικό σας τα αιτήματά μου.http αρχείο με τα εξής:

ΘΕΣΗ https://jsonplaceholder.typicode.com/posts HTTP/1.1
Τύπος περιεχομένου: "application/json"
{
 "τίτλος": "foo",
 "body": "bar",
 "userId": 1
}

Κάντε κλικ στο Στείλε αίτημα κουμπί για να στείλετε το αίτημα. Και πάλι, αυτό θα ανοίξει ένα νέο παράθυρο που περιέχει τα δεδομένα απόκρισης. Η απάντηση δείχνει ένα HTTP/1.1 201 Δημιουργήθηκε μήνυμα και το αναγνωριστικό της ανάρτησης μαζί με άλλα δεδομένα εάν η κλήση API είναι επιτυχής.

{
 "id": "101"
}

Υποβολή αιτήματος PUT χρησιμοποιώντας την επέκταση πελάτη REST

Κάνετε ένα αίτημα PUT όταν θέλετε να ενημερώσετε δεδομένα στο διακομιστή.

Για να ενημερώσετε έναν υπάρχοντα πόρο στο JSONPlaceholder API, αντικαταστήστε τον κώδικα στο δικό σας τα αιτήματά μου.http αρχείο με τα εξής:

ΒΑΖΩ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Τύπος περιεχομένου: "application/json"
{
 "τίτλος": "new foo",
 "body": "new bar",
 "userId": 1
}

Μετά την αποστολή του αιτήματος, ο πόρος θα ενημερωθεί στον εικονικό διακομιστή και θα λάβετε ένα HTTP/1.1 200 OK μήνυμα.

Υποβολή αιτήματος PATCH χρησιμοποιώντας την επέκταση πελάτη REST

Κάνετε ένα αίτημα PATCH όταν θέλετε να τροποποιήσετε ένα συγκεκριμένο πεδίο ή ιδιότητα ενός δεδομένου πόρου στο διακομιστή.

Για να ενημερώσετε μόνο τον τίτλο ενός υπάρχοντος πόρου στον εικονικό διακομιστή, αντικαταστήστε τον κώδικα στον δικό σας τα αιτήματά μου.http αρχείο με τα εξής:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Τύπος περιεχομένου: "application/json"
{
 "τίτλος": "άλλος τρόμος"
}

Αφού υποβάλετε το αίτημα, ο τίτλος του πόρου θα ενημερωθεί στον εικονικό διακομιστή και θα λάβετε ένα HTTP/1.1 200 OK μήνυμα μαζί με τα άλλα δεδομένα του πόρου.

Υποβολή αιτήματος ΔΙΑΓΡΑΦΗΣ χρησιμοποιώντας την επέκταση πελάτη REST

Κάνετε ένα αίτημα DELETE όταν θέλετε να διαγράψετε έναν πόρο στον διακομιστή.

Για να διαγράψετε έναν υπάρχοντα πόρο στον εικονικό διακομιστή, αντικαταστήστε τον κωδικό στον δικό σας τα αιτήματά μου.http αρχείο με τα εξής:

ΔΙΑΓΡΑΦΩ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Εδώ, το Τύπος περιεχομένου δεν απαιτείται, ούτε και το αντικείμενο δεδομένων. Εάν στείλετε το αίτημα και διαγράψετε με επιτυχία τον πόρο, θα πρέπει να λάβετε ένα HTTP/1.1 200 OK απάντηση με ένα κενό αντικείμενο.

Πραγματοποιήστε κλήσεις API απευθείας από το εσωτερικό του κώδικα VS

Προηγουμένως, μπορεί να χρησιμοποιούσατε εργαλεία τρίτων όπως Ταχυδρόμος για την υποβολή αιτημάτων API. Ενώ αυτά τα εργαλεία κάνουν καλά τη δουλειά τους, χρειάζεται χρόνος για να τα εγκαταστήσετε. Για παράδειγμα, πρέπει να έχετε λογαριασμό με τον Postman για να χρησιμοποιήσετε τον εξερευνητή API.

Αν και υπάρχουν πολλά διαδικτυακά εργαλεία δοκιμών API, αλλά με επεκτάσεις όπως το REST Client, η δοκιμή των API είναι πολύ πιο γρήγορη και ευκολότερη. Μπορείτε να δοκιμάσετε οποιοδήποτε API απευθείας μέσα από το πρόγραμμα επεξεργασίας κώδικα VS. Αυτό είναι ιδιαίτερα χρήσιμο εάν αναπτύσσετε API τοπικά και θέλετε να δοκιμάσετε τα τοπικά σας API εν κινήσει.

Άλλες επεκτάσεις API Testing VS Code

Το Rest Client είναι εύκολο στη χρήση. Ωστόσο, δεν είναι η μόνη επέκταση κώδικα VS για τη δοκιμή API. Άλλες δημοφιλείς επιλογές είναι το Thunder Client, το httpYak και το httpBook.

Το Thunder Client παρέχει ένα οπτικό πρόγραμμα επεξεργασίας API για την απλοποίηση των αιτημάτων API. Φυσικά, πρέπει να γνωρίζετε τι είναι το REST API για να χρησιμοποιήσετε αυτά τα εργαλεία.