Κοινοποίηση μέσω

Δομή τεκμηρίωσης του REST API Fabric

Τα API REST του Microsoft Fabric έχουν σχεδιαστεί για να βοηθούν τους προγραμματιστές να αυτοματοποιήσουν το Fabric. Οι σελίδες αναφοράς του REST API Fabric (τεκμηρίωση) είναι δομημένες για να βοηθήσουν τους προγραμματιστές να βρουν τις πληροφορίες που χρειάζονται.

Οι σελίδες αναφοράς χωρίζονται σε δύο κύριες ενότητες:

  • Βασικά API - Τα Βασικά API παρέχουν πληροφορίες και λειτουργίες για όλα τα στοιχεία στο Microsoft Fabric. Τα βασικά API δεν αφορούν συγκεκριμένα έναν φόρτο εργασίας και μπορούν να χρησιμοποιηθούν σε όλους τους φόρτους εργασίας. Τα API πυρήνα είναι API δημιουργίας, ανάγνωσης, ενημέρωσης και διαγραφής (CRUD). Μπορείτε να τα χρησιμοποιήσετε για να δημιουργήσετε ή να ενημερώσετε στοιχεία Fabric μαζί με τις συνήθεις ιδιότητές τους. Τα API πυρήνα μπορούν να χρησιμοποιηθούν κατά την εκτέλεση λειτουργιών δέσμης που δεν επιβάλλουν χειρισμό οποιασδήποτε ιδιότητας συγκεκριμένης για έναν συγκεκριμένο τύπο στοιχείου.

  • API φόρτου εργασίας - Τα API φόρτου εργασίας στοχεύουν έναν συγκεκριμένο τύπο στοιχείου στο Fabric.

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

Καταχώρηση συγκεκριμένου στοιχείου

Η ενότητα για κάθε στοιχείο περιγράφει τις λεπτομέρειες κάθε τύπου στοιχείου στο Fabric. Κάθε καταχώρηση τύπου στοιχείου περιέχει:

  • Επισκόπηση: Μια σύντομη περιγραφή του τύπου στοιχείου.

  • Τελικά σημεία: Παραθέτει τα διαθέσιμα τελικά σημεία για τον τύπο στοιχείου, μαζί με λεπτομέρειες σχετικά με παραμέτρους, μορφές αίτησης και απόκρισης και παραδείγματα.

  • Μοντέλα: Ορίζει το μοντέλο δεδομένων για τον τύπο στοιχείου, καθορίζοντας ιδιότητες και τύπους.

  • Ενέργειες: Παραθέτει τις διαθέσιμες ενέργειες για τον τύπο στοιχείου, συμπεριλαμβανομένων λεπτομερειών σχετικά με παραμέτρους, μορφές αίτησης και απόκρισης και παραδείγματα.

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

Δομή σελίδας αναφοράς

Κάθε σελίδα αναφοράς έχει τις ακόλουθες ενότητες:

  • Επισκόπηση - Μια σύντομη παράγραφος στο επάνω μέρος του άρθρου που περιγράφει το API.

  • Δικαιώματα - Μια λίστα των δικαιωμάτων χρήστη που απαιτούνται για την κλήση του API.

  • Απαιτούμενη εμβέλεια - Μια λίστα δικαιωμάτων (γνωστή και ως εμβέλειες) που απαιτεί το API.

  • Περιορισμοί - (Προαιρετικό) Μια λίστα περιορισμών για το API.

  • Διασύνδεση - Εμφανίζει τη μορφή HTTP του API.

  • Παράμετροι URI - Μια λίστα παραμέτρων που χρησιμοποιούνται για τον προσδιορισμό ενός συγκεκριμένου πόρου ή πόρων.

  • Σώμα αίτησης - Μια λίστα ιδιοτήτων που μπορούν να διαβιβαστούν στο API.

  • Αποκρίσεις - Μια λίστα πιθανών αποκρίσεων από το API.

  • Παραδείγματα - Μια λίστα παραδειγμάτων που δείχνει πώς μπορείτε να χρησιμοποιήσετε το API.

  • Ορισμοί - Παράμετροι που ορίζουν τη δομή και τις ιδιότητες ενός αντικειμένου που μπορούν να διαβιβαστούν στο API.

Η νέα δομή αναφοράς τεκμηρίωσης API έχει ως στόχο να παρέχει έναν σαφή και συνεπή τρόπο πρόσβασης και χρήσης των πληροφοριών API. Διαχωρίζοντας την ενότητα CORE και την καταχώρηση για το συγκεκριμένο στοιχείο, ελπίζουμε ότι θα διευκολύνουμε τους προγραμματιστές στην εύρεση και χρήση των πληροφοριών που χρειάζονται για ενοποίηση με την υπηρεσία Microsoft Fabric.

Χαιρετίζουμε τα σχόλια και τις προτάσεις σας σχετικά με τον τρόπο βελτίωσης της τεκμηρίωσης και του API.

Σχετικό περιεχόμενο

  • Last updated on