Ένα τελικό σημείο API είναι ένα σημείο σύνδεσης μεταξύ δύο προγραμμάτων λογισμικού. Τα API έχουν τελικά σημεία για κάθε πόρο. Τα τελικά σημεία καθορίζουν την ακριβή θέση ενός πόρου στο διακομιστή.
Όταν μια εφαρμογή πελάτη ζητά πληροφορίες από τον διακομιστή, περνά από το API. Το οποίο στη συνέχεια αποκτά πρόσβαση στο αίτημα και επεξεργάζεται μια απάντηση από τον διακομιστή. Στη συνέχεια, το API μεταφέρει τις ζητούμενες πληροφορίες από το τελικό σημείο στην εφαρμογή.
Το API σας είναι αποτελεσματικό εάν μπορεί να επικοινωνεί αποτελεσματικά μέσω των τελικών σημείων του. Διευκολύνει την πρόσβαση των χρηστών στους πόρους, βελτιώνοντας την εμπειρία του χρήστη.
Πώς λειτουργεί ένα τελικό σημείο API;
Τα ολοκληρωμένα συστήματα επικοινωνούν μέσω API. Ένα σύστημα στέλνει ένα αίτημα στο API, χρησιμοποιώντας μια μορφή όπως SOAP ή REST
. Ο διακομιστής λαμβάνει τα αιτήματα και μεταφέρει την απάντηση πίσω στο API. Η τοποθεσία αυτού του ζητούμενου πόρου είναι το τελικό σημείο.Προτού ένα τελικό σημείο επεξεργαστεί ένα αίτημα, ο πελάτης πρέπει να παρέχει μια διεύθυνση URL, κεφαλίδες και ένα σώμα. Οι κεφαλίδες περιέχουν μεταδεδομένα σχετικά με ένα αίτημα και τα δεδομένα λεπτομερειών σώματος που αποστέλλονται στον διακομιστή. Ένας διακομιστής μπορεί επίσης να συνδεθεί σε μια βάση δεδομένων που Μέθοδοι API μπορεί να έχει πρόσβαση.
Τα τελικά σημεία API λειτουργούν συνήθως με μεθόδους HTTP όπως GET, DELETE, PATCH ή POST. Οι μέθοδοι καθορίζουν πώς να χρησιμοποιήσετε ένα τελικό σημείο. Όταν ένας πελάτης στέλνει ένα αίτημα, πρέπει να το διατυπώσει ώστε να περιλαμβάνει τη μέθοδο αιτήματος καθώς και τη διεύθυνση URL, για παράδειγμα:
ΠΑΙΡΝΩ https://example.com/books/authorsΗ ονομασία είναι δύσκολη, είτε πρόκειται για τελικά σημεία API, δικτυωμένες συσκευές υλικού, ή συναρτήσεις και μεταβλητές. Θα πρέπει να μάθετε για ορισμένες βέλτιστες πρακτικές που μπορείτε να χρησιμοποιήσετε για να διασφαλίσετε ότι τα τελικά σημεία του API αποτελούν πλεονέκτημα.
1. Χρησιμοποιήστε μια κάθετο προς τα εμπρός
Να χρησιμοποιείτε πάντα κάθετες προς τα εμπρός για να διαχωρίζετε πόρους URI. Οι κάθετες βοηθούν επίσης στην εμφάνιση της ιεραρχίας των πόρων. Το παρακάτω είναι ένα παράδειγμα:
https://example.com/books/authors2. Χρησιμοποιήστε ουσιαστικά, όχι ρήματα
Θα πρέπει να χρησιμοποιείτε μόνο ουσιαστικά για να ονομάσετε έναν πόρο. Τα ουσιαστικά περιγράφουν τι είναι ένας πόρος σε αντίθεση με ένα ρήμα που περιγράφει τι κάνει ένας πόρος. Ακολουθεί ένα παράδειγμα ενός καλού και ενός κακού τρόπου για να ονομάσετε τα τελικά σημεία του API.
Καλή ονομασία:
https://example.com/api/getBooksΚακή ονομασία:
http://example.com/api/books3. Χρησιμοποιήστε Πληθυντικό Ουσιαστικά, Όχι Ενικό
Θα πρέπει πάντα να ονομάζετε τα τελικά σημεία του API σας σε πληθυντικά ουσιαστικά. Αυτό υποδεικνύει σε έναν χρήστη ότι υπάρχουν περισσότεροι από ένας πόροι στον διακομιστή. Η χρήση ενός ενικού ουσιαστικού μπορεί να μπερδέψει τον χρήστη να πιστέψει ότι υπάρχει μόνο ένας πόρος.
Καλή ονομασία:
https://example.com/api/book/3Κακή ονομασία:
http://example.com/api/books/34. Χρησιμοποιήστε πεζά γράμματα
Θα πρέπει να πληκτρολογήσετε όλες τις διευθύνσεις URL με πεζά. Αυτό περιλαμβάνει διευθύνσεις URL τελικού σημείου API. Εδώ είναι ένα παράδειγμα:
Καλή ονομασία:
http://example.com/api/Books/3Κακή ονομασία:
http://example.com/api/books/35. Χρησιμοποιήστε παύλες για να διαχωρίσετε λέξεις
Χρησιμοποιήστε παύλες για να διαχωρίσετε συνδυασμένες λέξεις. Οι παύλες έχουν ως αποτέλεσμα πιο ευανάγνωστες φράσεις από ό, τι η θήκη ή οι κάτω παύλες. Είναι επίσης καλύτερα για σκοπούς SEO.
Καλή ονομασία:
https://example.com/api/books/33/front_coverΚακή ονομασία:
https://example.com/api/books/33/front-cover6. Μην προσθέτετε επεκτάσεις αρχείων
Δεν χρειάζεται να προσθέσετε επέκταση αρχείου στα τελικά σημεία του API. Αν και δεν επηρεάζει την έξοδο, μια επέκταση καθιστά δυσκολότερη την ανάγνωση του πόρου. Επίσης, κάνει τον πόρο λιγότερο ευέλικτο, σπάζοντας τον εάν αλλάξει η επέκταση στο μέλλον.
Καλή ονομασία:
https://example.com/api/books.xmlΚακή ονομασία:
https://example.com/api/books7. Συμπεριλάβετε την έκδοση
Θα πρέπει πάντα να ονομάζετε τα τελικά σημεία του API σύμφωνα με την έκδοση. Αυτό είναι σημαντικό εάν κάνετε σημαντικές αλλαγές στο API. Βοηθά στη διαφοροποίηση μεταξύ δύο ή περισσότερων εκδόσεων API από την οποία προέρχεται ο πόρος. Μπορείτε να υποδείξετε την έκδοση στην αρχή του τελικού σημείου.
Για παράδειγμα:
https://example.com/api/v3/booksΓιατί να εξετάσετε τις βέλτιστες πρακτικές του API;
Τα API έχουν γίνει η ραχοκοκαλιά του σύγχρονου προγραμματισμού. Βελτιώνουν τη συνεργασία, ενθαρρύνουν την καινοτομία και βελτιώνουν την ασφάλεια εφαρμογών.
Είτε χρησιμοποιούν νέα εργαλεία είτε διαχειρίζονται υπάρχοντα, τα API απλοποιούν τη διαδικασία. Επομένως, είναι απαραίτητο να υπάρχουν τελικά σημεία που βελτιώνουν την εμπειρία του χρήστη. Η ονομασία και η δομή των τελικών σημείων του API καθορίζουν την απόδοση του API σας.
Βεβαιωθείτε ότι χρησιμοποιείτε βέλτιστες πρακτικές για τη δημιουργία αποτελεσματικών τελικών σημείων API.