Σύνδεση σε API χωρίς κωδικό: 8 βήματα

2024 Συγγραφέας: John Day | [email protected]. Τελευταία τροποποίηση: 2024-01-30 08:32

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

Αν αυτό σας ακούγεται, είστε τυχεροί! Είμαστε εδώ για να εξηγήσουμε πώς να εργάζεστε με API, πώς να διαβάζετε έγγραφα API και πώς να χρησιμοποιείτε πραγματικά τα δεδομένα που προέρχονται από ένα API.

Έχουμε φέρει έναν φίλο μαζί μας για να κάνει το ταξίδι πολύ πιο εύκολο.

Γνωρίστε τον Σλας

Ο Σλας είναι το αξιολάτρευτο, αξιαγάπητο σκυλί της Μισέλ (φωτογραφία παραπάνω). Η Michelle είναι μηχανικός λογισμικού που κατασκευάζει API. Η Michelle απολαμβάνει πραγματικά τη δουλειά της και έχει αντλήσει έμπνευση από τα εργασιακά της κτίρια API στην εκπαίδευση του Slash.

Όπως ίσως γνωρίζετε, ένα API είναι μια συλλογή εντολών που ένας χρήστης μπορεί να δώσει σε μια υπηρεσία ιστού μαζί με ένα σύνολο απαντήσεων που ταιριάζουν με το αίτημα. Η Michelle έχει εκπαιδεύσει τον Slash να κάνει ακριβώς το ίδιο. Ο Slash είναι καλό παιδί, γνωρίζει διάφορες εντολές και πάντα απαντά σωστά, αρκεί να του δώσετε ένα αίτημα που του έχουν διδάξει. Όταν ενθουσιάζεται πολύ, η ουρά του τρελαίνεται - αυτό δεν είναι κάτι που του έμαθε η Μισέλ που σχετίζεται με τα API, είναι μόνο επειδή είναι ένα αξιαγάπητο κουτάβι και απολαμβάνει πραγματικά την εκπαίδευσή του!

Βήμα 1: Αποφασίστε τι API χρειάζεστε

Τι πληροφορίες αναζητάτε ή θέλετε να αλλάξετε;

Προσπαθείτε να πιάσετε όλες τις αναρτήσεις του @dougthepug στο Instagram; Maybeσως θέλετε να κάνετε αυτόματα tweet σε όποιον ακολουθεί το twitter του σκύλου σας (γιατί παρόλο που τα σκυλιά δεν μπορούν να μιλήσουν, έχουν πολλά να πουν, γνωρίζουμε ότι ο Slash σίγουρα το κάνει).

Εάν γνωρίζετε ήδη τον ιστότοπο ή το API στο οποίο προσπαθείτε να συνδεθείτε, μεταβείτε απευθείας στο Βήμα 2. Εάν προσπαθείτε να βρείτε δεδομένα, αλλά δεν είστε σίγουροι από πού να ξεκινήσετε, η Google είναι ο φίλος σας. Αναζητήστε το "[υλικό που σας ενδιαφέρει] API" και δείτε τι θα προκύψει. Μπορεί να εκπλαγείτε πόσες πληροφορίες υπάρχουν.

Αν θέλετε ένα απλό παράδειγμα API, μπορείτε να χρησιμοποιήσετε αυτό που έκανε η Michelle κατά την εκπαίδευση του Slash. Έχει μερικές από τις αγαπημένες του εντολές όπως ανάκτηση μπάλες και σκάψιμο τρυπών. Θα το χρησιμοποιήσουμε στα υπόλοιπα παραδείγματά μας.

Βήμα 2: Βρείτε τα Έγγραφα API

Τα API που παρέχονται από γνωστές εταιρείες πρέπει να έχουν εμπεριστατωμένη τεκμηρίωση για τον τρόπο χρήσης τους.

Για να τα βρείτε, κάντε google "[Insert Company] API Documentation" ή "[Insert Company] developer".

Τα αποτελέσματα πρέπει να σας μεταφέρουν στην πύλη προγραμματιστών. Αναζητήστε έναν σύνδεσμο που λέει "Έγγραφα", "Τεκμηρίωση", "Αναφορά" ή "Τεχνική αναφορά".

Στα έγγραφα, ίσως χρειαστεί να αναζητήσετε το συγκεκριμένο API που θέλετε, καθώς μερικές φορές μπορεί να υπάρχουν πολλές επιλογές. Το Facebook, για παράδειγμα, διαθέτει ξεχωριστά API για μάρκετινγκ, διαφημίσεις, σελίδες και άλλα.

Εάν το API στο οποίο θέλετε να συνδεθείτε δεν είναι πολύ γνωστό (όπως αυτό του Slash), ίσως χρειαστεί να ζητήσετε τεκμηρίωση από τον προγραμματιστή. Μπορεί να έχουν ένα PDF που περιέχει τις πληροφορίες που χρειάζεστε ή ηλεκτρονική τεκμηρίωση που δεν αναφέρεται στον ιστότοπό τους.

Εάν χάσατε τον σύνδεσμο στο προηγούμενο βήμα, τα έγγραφα API του Slash μπορείτε να τα βρείτε εδώ.

Βήμα 3: Βρείτε το τελικό σημείο

Τα έγγραφα API μπορεί να φαίνονται τρομακτικά, αλλά μόλις ξέρετε τι να ψάξετε είναι συνήθως καλά δομημένα και αρκετά τυποποιημένα.

Το πρώτο πράγμα που πρέπει να αναζητήσετε είναι το κατάλληλο τελικό σημείο. Θα πρέπει να υπάρχει ένα τελικό σημείο που αντιστοιχεί σε κάθε τύπο δεδομένων που θέλετε. Ένα τελικό σημείο θα μπορούσε να μοιάζει με αυτό:

slashtheapidog.com/api/bones/{id}

ή απλά

/οστά

Η τεκμηρίωση πρέπει να έχει μια λίστα με τα τελικά σημεία. Μπορεί να είναι ανώτατου επιπέδου στα έγγραφα ή κάτω από μια ενότητα που ονομάζεται "αναφορά", "τελικά σημεία" ή "μέθοδοι". Για να βρείτε το σωστό τελικό σημείο, αναζητήστε το όνομα που αντιστοιχεί στα δεδομένα που αναζητάτε. Για παράδειγμα, εάν θέλετε μια λίστα με όλες τις τρύπες που έχει ανοίξει ο Slash, /οι τρύπες είναι πιθανώς η σωστή. Σε κάθε περίπτωση, κάθε τελικό σημείο πρέπει να έχει μια περιγραφή για να εξηγήσει τι κάνει.

Από τα έγγραφά του, αυτά είναι τα τελικά σημεία στο API του Slash που σχετίζονται με τις τρύπες:

ΛΗETΗ

ΛΗΗ

ΑΝΑΡΤΗΣΤΕ

ΒΑΛΤΕ

ΑΝΑΡΤΗΣΤΕ

Βήμα 4: Καθορίστε τον τύπο του αιτήματός σας

Τώρα που βρήκατε το σωστό τελικό σημείο, πρέπει να καθορίσετε τον τύπο του αιτήματος για να το στείλετε.

Υπάρχουν 4 διαφορετικοί τύποι αιτημάτων:

ΠΑΙΡΝΩ

Ένα αίτημα GET είναι το πώς ζητάτε από το API να απαντήσει με κάτι που έχει, πιο συχνά δεδομένα. Μπορείτε να ζητήσετε συγκεκριμένες πληροφορίες σχετικά με ένα στοιχείο ή μια ομάδα στοιχείων με βάση το τελικό σημείο και τις παραμέτρους. Αυτό ισοδυναμεί με το να ζητήσετε από τον Σλας να σας φέρει ένα από τα κόκαλά του ή όλα του τα κόκαλα.

ΘΕΣΗ

Ένα αίτημα POST είναι πώς λέτε στο API να δημιουργήσει κάτι νέο. Αυτό μοιάζει με το να ζητάς από τον Slash να σκάψει (δημιουργήσει) μια νέα τρύπα για σένα.

ΒΑΖΩ

Ένα αίτημα PUT είναι το πώς λέτε στο API να ενημερώσει κάτι που δημιουργήθηκε προηγουμένως. Αυτό μοιάζει με το να ζητάμε από τον Slash να σκάψει βαθύτερα (ενημέρωση) στην τρύπα που άνοιξε.

ΔΙΑΓΡΑΦΩ

Ένα αίτημα ΔΙΑΓΡΑΦΗ είναι πώς λέτε στο API να διαγράψει κάτι που δημιουργήθηκε προηγουμένως. Αυτό μοιάζει με το να ζητάει από τον Slash να καλύψει (διαγράψει) μια τρύπα που είχε σκάψει προηγουμένως.

Σκεφτείτε αυτούς τους τέσσερις τύπους. Λαμβάνετε πληροφορίες, δημιουργείτε μια νέα καταχώρηση, αλλάζετε μια υπάρχουσα καταχώρηση ή διαγράφετε μια; Αυτή η απάντηση σας λέει ακριβώς τι τύπο αιτήματος χρειάζεστε.

Βήμα 5: Κατανόηση των παραμέτρων

Πολλά αιτήματα απαιτούν πρόσθετες παραμέτρους. Οι παράμετροι είναι οι λεπτομέρειες του αιτήματός σας. Για παράδειγμα, εάν θέλετε το Slash να σας φέρει όλες τις κόκκινες μπάλες, πρέπει να καθορίσετε το χρώμα. Αν θέλετε να δημιουργήσει μια νέα τρύπα, πρέπει να του πείτε πού να το βάλει και πόσο βαθιά να σκάψει.

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

Οι παράμετροι API του Slash μπορεί να μοιάζουν κάπως έτσι για την ανάκτηση μπάλες:

Λάβετε

Βήμα 6: Μορφοποιήστε το αίτημά σας

Έχουμε όλες τις πληροφορίες που χρειαζόμαστε, τώρα απλά πρέπει να κάνουμε το αίτημα!

Ακολουθούν δύο διαφορετικοί τρόποι σύνδεσης σε ένα API που δεν απαιτούν κωδικό. Ας συνδεθούμε με το API του Slash για να λάβουμε τη λίστα με τις μπάλες του κάνοντας ένα αίτημα GET στη διεύθυνση

Παραβολή - εάν θέλετε να συνδεθείτε και να εργαστείτε με δεδομένα χωρίς κώδικα

Το Parabola είναι μια εφαρμογή ιστού που σας επιτρέπει να συνδέεστε εύκολα σε API και στη συνέχεια να εργάζεστε με τα δεδομένα μέσω ενός οπτικού εργαλείου μεταφοράς και απόθεσης.