Ξεκινήστε με το API Microsoft Learn Catalog με χρήση των curl και Visual Studio Code
Αυτό το άρθρο θα σας βοηθήσει να ξεκινήσετε να χρησιμοποιείτε το API Microsoft Learn Catalog με μπούκλες και κώδικα Visual Studio. Εάν δεν είστε εξοικειωμένοι με τις λεπτομέρειες του API ή τις περιπτώσεις χρήσης για αυτό, συνιστούμε να εξετάσετε πρώτα το άρθρο επισκόπησης δυνατοτήτων API Learn Catalog.
Η διαδικασία υψηλού επιπέδου που θα δούμε είναι:
- Υποβολή ερωτήματος για το API Learn Catalog
- Εξέταση της αρχικής απάντησης
- "Προοίμιο" της απόκρισης
- Μετατροπή του σε υπολογιστικό φύλλο
- Δοκιμάστε περισσότερα ερωτήματα
Όταν αρχίσετε να χρησιμοποιείτε το API Learn Catalog για τις δικές σας ανάγκες, μπορεί να διαπιστώσετε ότι τροποποιείτε αυτά τα βήματα ελαφρώς για το σύνολο εργαλείων ή τις ανάγκες που θέλετε, αλλά γενικά η διαδικασία χρήσης του είναι ίδια για όλες τις περιπτώσεις χρήσης.
Προαπαιτούμενα στοιχεία
Για να ακολουθήσετε τα βήματα που περιγράφονται σε αυτό το άρθρο, θα χρειαστείτε μπούκλες και Κώδικα Visual Studio, δύο δημοφιλή, δωρεάν εργαλεία για την υποβολή ερωτημάτων για API.
- Εάν έχετε ήδη εγκαταστήσει το Curl και το Visual Studio Code, μπορείτε να προχωρήσετε στην ενότητα Ερώτημα για το API Learn Catalog.
- Εάν δεν τα έχετε εγκαταστήσει, ακολουθήστε τις οδηγίες στις παρακάτω ενότητες.
Λήψη και ρύθμιση μπούκλας
Το curl είναι ένα δημοφιλές, δωρεάν εργαλείο γραμμής εντολών ανοιχτού κώδικα που μπορεί να εκτελεί ερωτήματα για API.
- Μεταβείτε στη σελίδα λήψης μπούκλας και κάντε λήψη του πακέτου που ισχύει για το περιβάλλον σας. Εάν δεν είστε βέβαιοι ποιο θα επιλέξετε, χρησιμοποιήστε τον οδηγό λήψης για μπούκλες.
- Εγκαταστήστε την εφαρμογή και ακολουθήστε τις οδηγίες για να ρυθμίσετε τις παραμέτρους. Δεν υπάρχουν μοναδικές ρυθμίσεις που απαιτούνται για αυτό το άρθρο ή για την υποβολή ερωτημάτων στο API Learn Catalog.
Λήψη και ρύθμιση του Visual Studio Code
Το Visual Studio Code είναι ένα δωρεάν, ισχυρό πρόγραμμα επεξεργασίας κώδικα που έχει δημιουργηθεί από τη Microsoft.
- Μεταβείτε στην τοποθεσία του Visual Studio Code και κάντε λήψη του πακέτου που ισχύει για το περιβάλλον σας.
- Εγκαταστήστε την εφαρμογή και ακολουθήστε τις οδηγίες για να ρυθμίσετε τις παραμέτρους.
Υποβολή ερωτήματος για το API Learn Catalog
Επειδή δεν απαιτείται έλεγχος ταυτότητας για τη χρήση του API Learn Catalog, μπορείτε να υποβάλετε ερώτημα στο τελικό σημείο API από οποιαδήποτε γραμμή εντολών με δυνατότητα κέρκλας. Για αυτή την άσκηση, θα χρησιμοποιήσουμε το τερματικό εντός του Visual Studio Code.
- Ανοίξτε το Visual Studio Code.
- Επιλέξτε Τερματικό στην επάνω γραμμή περιήγησης.
- Επιλέξτε Νέο τερματικό για να ανοίξετε ένα νέο τερματικό εντολών.
- Επιλέξτε το τερματικό επιλογής σας (Bash, CMD κ.λπ.) και πληκτρολογήστε την παρακάτω εντολή. Η παρακάτω εντολή υποδεικνύει ότι θέλει να χρησιμοποιήσει μπούκλα, να καλέσει το τελικό σημείο API Χωρίς φιλτράρισμα Learn Catalog και θα εξάγει την απόκριση σε ένα αρχείο με την ονομασία "output.json", στη θέση που ορίζεται στη διαδρομή αρχείου που εμφανίζεται στο τερματικό (π.χ.:
C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
- Εάν η αίτηση ήταν επιτυχής, θα πρέπει να δείτε πληροφορίες σχετικά με το συνολικό μέγεθος του αρχείου, όπως 13,1 M (το μέγεθος υπόκειται σε αλλαγές, ανάλογα με το μέγεθος της απόκρισης). Εάν αυτό ήταν ανεπιτυχές, θα πρέπει να λάβετε ένα σφάλμα.
Σημείωμα
Θα πρέπει να διαγράψετε το αρχείο output.json αφού ολοκληρώσετε τη χρήση του ή να το μετονομάσετε ώστε να ισχύει περισσότερο. Εάν υποβάλετε ξανά ερώτημα στο API χρησιμοποιώντας το ίδιο όνομα αρχείου, θα προσαρτήσει την απόκριση μέσα στο υπάρχον αρχείο. Μια άλλη επιλογή είναι να ονομάσετε το αρχείο πιο μοναδικά κατά τη διάρκεια της εντολής αρχικού ερωτήματος, όπως "output-1212.json" ή "output-de-de-2022-12-12.json".
Εξέταση της αρχικής απάντησης
Η αρχική απόκριση είναι σε JSON και θα "ελαχιστοποιηθεί", πράγμα που σημαίνει ότι ορισμένα διαστήματα, γραμμές και στηλοθόμπας καταργούνται για να μειωθεί το αρχείο.
- Στο Visual Studio Code, επιλέξτε Αρχείο.
- Επιλέξτε Άνοιγμα αρχείου.
- Μεταβείτε στο αρχείο "output.json" που δημιουργήθηκε ως μέρος της προηγούμενης ενότητας.
Αυτή η ελαχιστοποίηση είναι μια τυπική πρακτική και το αρχείο μπορεί να "προρυθμιστεί" για να είναι πιο ευανάγνωστο από μια εντολή στο Visual Studio Code, κάτι που θα κάνουμε στην επόμενη ενότητα.
Προετοίμιος της απόκρισης
- Με ανοιχτό το αρχείο "output.json" στο Visual Studio Code, χρησιμοποιήστε τον συνδυασμό πλήκτρων Ctrl+Shift+I.
Το JSON θα πρέπει να ενημερωθεί ώστε να διαιρείται σε πολλές γραμμές και να είναι σε μορφή πιο ευανάγνωστη. Για πληροφορίες σχετικά με τις διαφορετικές ιδιότητες και τιμές στην απόκριση, προβάλετε το άρθρο Αναφορά προγραμματιστών API Learn Catalog για το λεξικό δεδομένων.
Μετατροπή της απόκρισης σε υπολογιστικό φύλλο
Υπάρχουν πολλά άτομα που χρησιμοποιούν το API Learn Catalog για μεμονωμένες εργασίες ή αναθεώρηση, σε αντίθεση με την ενσωμάτωσή του σε ένα σύστημα. Για αυτές τις περιπτώσεις χρήσης, μπορεί να είναι χρήσιμο να μετατρέψετε την απόκριση JSON σε μορφή CSV ή Excel για προβολή ως υπολογιστικό φύλλο. Μπορείτε να χρησιμοποιήσετε οποιοδήποτε προτιμώμενο εργαλείο μετατροπής, αλλά εδώ μπορούμε να χρησιμοποιήσουμε το Json Flatfile σε μετατροπέα CSV.
- Μετάβαση σε: https://csvjson.com/json2csv.
- Αποστείλετε το αρχείο εξόδου.
- Επιλέξτε Μετατροπή.
- Επιλέξτε Λήψη.
Σημείωμα
Να είστε πολύ προσεκτικοί με τα εξωτερικά online εργαλεία για να μετατρέψετε δεδομένα και να εξετάσετε τα δεδομένα που εισάγετε σε αυτά. Στην περίπτωση του API Learn Catalog, η απόκριση είναι διαθέσιμη στο κοινό και δεν απαιτεί έλεγχο ταυτότητας, επομένως μπορείτε να χρησιμοποιήσετε ένα ηλεκτρονικό εργαλείο για να σας βοηθήσει να μετατρέψετε τη μορφή.
Δοκιμάστε περισσότερα ερωτήματα
Ακολουθήστε τα παραπάνω βήματα για να δοκιμάσετε περισσότερα ερωτήματα, όπως αυτά που παρατίθενται παρακάτω. Δείτε πώς αλλάζει το μέγεθος του αρχείου απόκρισης για κάθε ένα και τη διαφορά στα αντικείμενα μέσα σε αυτό.
| Description | Query |
|---|---|
| Όλα τα στοιχεία στο API Learn Catalog | https://learn.microsoft.com/api/catalog/ |
| Όλες οι εκπαιδευτικές ενότητες στα Ισπανικά | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
| Όλες οι εκπαιδευτικές ενότητες με βαθμολογία δημοτικότητας 0,9 ή μεγαλύτερη | https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9 |
| Όλα τα αντικείμενα εκπαίδευσης και πιστοποίησης ασφάλειας για αρχάριους | https://learn.microsoft.com/api/catalog/?level=beginner&subject=security |
| Όλες οι προηγμένες εκπαιδευτικές ενότητες προσβασιμότητας με βαθμολογία δημοτικότητας πάνω από 0,5 και ενημερώθηκαν τον τελευταίο μήνα | https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01 |
Επόμενα βήματα
Συνιστούμε να εξετάσετε τους πόρους παρακάτω για να σας βοηθήσουμε στο ταξίδι ανάπτυξης: