Οδηγός για το σχήμα JSON
Πριν πάμε στο σχήμα JSON, είναι σημαντικό να γνωρίζουμε τη διαφορά μεταξύ του σχήματος JSON και του σχήματος JSON.
JSON
Το JSON είναι συντομογραφία του JavaScript Object Notation και είναι μια μορφή δεδομένων ανεξάρτητη από τη γλώσσα που χρησιμοποιούν τα API για την αποστολή αιτημάτων και απαντήσεων. Το JSON είναι απλό στην ανάγνωση και την εγγραφή τόσο για ανθρώπους όσο και για μηχανές. Το JSON είναι μια μορφή που βασίζεται σε κείμενο που δεν δεσμεύεται στη γλώσσα (ανεξάρτητη γλώσσα).
Σχήμα JSON
Το JSON Schema είναι ένα χρήσιμο εργαλείο για την επαλήθευση της δομής δεδομένων JSON. Για να καθορίσετε τη δομή του JSON, χρησιμοποιήστε μια μορφή που βασίζεται σε JSON. Σκοπός του είναι να διασφαλίσει ότι τα δεδομένα JSON είναι αποδεκτά. Η σύμβαση για τα δεδομένα JSON της εφαρμογής μας μπορεί να οριστεί χρησιμοποιώντας σχήμα.
Υπάρχουν τρεις κύριες ενότητες για την προδιαγραφή σχήματος JSON:
Υπερ-Σχήμα JSON:
Το JSON Hyper-Schema είναι μια γλώσσα JSON Schema που μπορεί να χρησιμοποιηθεί για την επισήμανση εγγράφων JSON με υπερσυνδέσμους και οδηγίες για την επεξεργασία και την αλλαγή εξωτερικών πόρων JSON μέσω περιβαλλόντων που βασίζονται σε κείμενο όπως το HTTP. Κάντε κλικ εδώ για να μάθετε περισσότερα σχετικά με το JSON Hyper-Schema.
Πυρήνας σχήματος JSON:
Είναι ένα σύνολο κανόνων για την επισήμανση και την επικύρωση εγγράφων JSON.
Πυρήνας σχήματος JSON:
- Περιγράφει τη μορφή δεδομένων που έχετε αυτήν τη στιγμή.
- Επικυρώνει δεδομένα που μπορούν να χρησιμοποιηθούν σε αυτοματοποιημένες δοκιμές.
- Διασφάλιση της ακρίβειας των δεδομένων που δίνονται από τους πελάτες.
- Παρέχει αναγνώσιμη τεκμηρίωση τόσο για ανθρώπους όσο και για μηχανές.
Επικύρωση σχήματος JSON:
Η επικύρωση που βασίζεται στο σχήμα JSON επιβάλλει όρια στη δομή των δεδομένων παρουσίας. Μετά από αυτό, τυχόν λέξεις-κλειδιά που δεν έχουν ισχυρισμό πληροφορίες, όπως περιγραφικά μεταδεδομένα και ενδείξεις χρήσης, προστίθενται σε μια θέση παρουσίας που πληροί όλους τους δηλωμένους περιορισμούς.
Το εργαλείο JSON Schema Validator της Newtonsoft είναι ένα εργαλείο που μπορείτε να χρησιμοποιήσετε απευθείας στο πρόγραμμα περιήγησής σας, χωρίς χρέωση. Μπορείτε να χρησιμοποιήσετε αυτό το εργαλείο για να δοκιμάσετε τη δομή του σχήματος JSON σας. Αυτή η σελίδα περιέχει στοιχεία ελέγχου και επεξηγήσεις για να ξεκινήσετε. Με αυτόν τον τρόπο, είναι εύκολο να δείτε πώς να βελτιώσετε τη δομή JSON σας.
Μπορούμε να ελέγξουμε το αντικείμενο JSON χρησιμοποιώντας το Εργαλείο επικύρωσης σχήματος JSON:
Έχουμε επικύρωση ηλικίας (ελάχιστο = 20 και μέγιστο = 40) όπως φαίνεται στο παραπάνω σχήμα. Δεν βρέθηκαν σφάλματα.
Εμφανίστηκε ένα σφάλμα εάν η επικύρωση ηλικίας είχε εισαχθεί λανθασμένα.
Η δημιουργία ενός σχήματος JSON
Ας δούμε ένα παράδειγμα του σχήματος JSON για να δούμε για τι πράγμα μιλάμε. Ένα βασικό αντικείμενο JSON που περιγράφει έναν κατάλογο προϊόντων είναι το εξής:
Το σχήμα JSON του μπορεί να γραφτεί ως εξής:
Ένα σχήμα JSON είναι ένα έγγραφο JSON και αυτό το έγγραφο ΠΡΕΠΕΙ να είναι αντικείμενο. Οι λέξεις-κλειδιά είναι μέλη αντικειμένων/χαρακτηριστικά που καθορίζονται από το JSON Schema. Οι "λέξεις-κλειδιά" στο σχήμα JSON αναφέρονται στο τμήμα "κλειδί" ενός συνδυασμού κλειδιού/τιμής σε ένα αντικείμενο. Η σύνταξη ενός σχήματος JSON περιλαμβάνει την αντιστοίχιση μιας συγκεκριμένης «λέξης-κλειδιού» σε μια τιμή μέσα σε ένα αντικείμενο ως επί το πλείστον.
Ας ρίξουμε μια πιο προσεκτική ματιά στις λέξεις-κλειδιά που χρησιμοποιήσαμε στο παράδειγμά μας:
Το σχήμα JSON στο οποίο συμμορφώνεται το σχήμα του πόρου καταγράφεται από αυτό το χαρακτηριστικό. Αυτό το σχήμα είναι γραμμένο σύμφωνα με το πρότυπο drafts v4, όπως καθορίζεται από το "σχήμα $» λέξη-κλειδί. Αυτό εμποδίζει το σχήμα σας να επιστρέψει στην τρέχουσα έκδοση, η οποία μπορεί να είναι συμβατή ή να μην είναι συμβατή με παλαιότερες.
Ο "τίτλος"Και"περιγραφήΟι λέξεις-κλειδιά είναι απλώς επεξηγηματικές. δεν επιβάλλουν περιορισμούς στα δεδομένα που ελέγχονται. Αυτές οι δύο λέξεις-κλειδιά περιγράφουν τον σκοπό του σχήματος: περιγράφει ένα προϊόν.
Ο "τύποςΗ λέξη-κλειδί ορίζει την πρώτη οριακή συνθήκη των δεδομένων JSON μας. πρέπει να είναι αντικείμενο JSON. Εάν δεν ορίσουμε τον τύπο για όλα τα σχήματα, ο κώδικας δεν θα λειτουργούσε. Μερικοί κοινοί τύποι είναι "αριθμός" "Boolean" "ακέραιος" "null" "αντικείμενο" "array" "string".
Το JSON Schema υποστηρίζεται από τις ακόλουθες βιβλιοθήκες:
Γλώσσα | Βιβλιοθήκη |
C | WJElement |
Python | jschon |
PHP | Opis Json Schema |
το JavaScript | ajv |
Go | gojsonschema |
Κοτλίν | Μήδεια-επικυρωτή |
Ruby | JSONSchemer |
JSON (Σύνταξη)
Ας ρίξουμε μια σύντομη ματιά στη θεμελιώδη σύνταξη του JSON. Η σύνταξη JSON είναι ένα υποσύνολο της σύνταξης JavaScript που περιλαμβάνει τα ακόλουθα στοιχεία:
- Χρησιμοποιούνται ζεύγη ονόματος/τιμής που αντιπροσωπεύουν δεδομένα.
- Τα αντικείμενα συγκρατούνται σε σγουρές αγκύλες και κάθε όνομα οδηγείται από ένα ':' (άνω τελεία), με τα ζεύγη τιμών να χωρίζονται με "," (κόμμα).
- Οι τιμές διαχωρίζονται με "," (κόμμα) και οι πίνακες διατηρούνται σε αγκύλες.
Οι ακόλουθες δύο δομές δεδομένων υποστηρίζονται από JSON:
- Ταξινομημένη λίστα τιμών: Μπορεί να είναι ένας πίνακας, μια λίστα ή ένα διάνυσμα.
- Συλλογή ζευγών ονόματος/τιμών: Διαφορετικές γλώσσες υπολογιστών υποστηρίζουν αυτήν τη Δομή Δεδομένων.
JSON (Αντικείμενο)
Ένα σχήμα JSON είναι ένα αντικείμενο JSON που περιγράφει τον τύπο και τη δομή ενός διαφορετικού αντικειμένου JSON. Μια έκφραση αντικειμένου JavaScript μπορεί να αντιπροσωπεύει ένα αντικείμενο JSON σε περιβάλλοντα χρόνου εκτέλεσης JavaScript. Μερικά παραδείγματα έγκυρων αντικειμένων σχήματος είναι τα εξής:
Schema | Αγώνες |
{} | οποιαδήποτε αξία |
{ type: 'object' } | ένα αντικείμενο JavaScript |
{ type: 'number' } | έναν αριθμό JavaScript |
{ type: 'string'} | μια συμβολοσειρά JavaScript |
Π.χ:
Δημιουργία νέου αντικειμένου που είναι κενό:
var JSON_Obj = {};
Δημιουργία νέου αντικειμένου:
var JSON_Obj = νέο αντικείμενο()
JSON (Σύγκριση με XML)
Τα JSON και XML είναι ανεξάρτητες από τη γλώσσα αναγνώσιμες μορφές. Σε σενάρια πραγματικού κόσμου, μπορούν να δημιουργήσουν, να διαβάσουν και να αποκωδικοποιήσουν. Με βάση τα ακόλουθα κριτήρια, μπορούμε να συγκρίνουμε το JSON με το XML.
Περίπλοκο
Επειδή το XML είναι πιο περίπλοκο από το JSON, οι προγραμματιστές προτιμούν το JSON.
Χρήση Πίνακες
Η XML χρησιμοποιείται για την έκφραση δομημένων δεδομένων. Ωστόσο, η XML δεν υποστηρίζει πίνακες, αλλά η JSON υποστηρίζει.
Τεχνολογία
Το JSON ερμηνεύεται χρησιμοποιώντας τη συνάρτηση eval της JavaScript. Το eval επιστρέφει το περιγραφόμενο αντικείμενο όταν χρησιμοποιείται με JSON.
Παράδειγμα:
JSON | XML |
{ «Εταιρεία»: Ferrari, "όνομα": "GTS", “Τιμή”: 404000 } |
Ferrari
GTS
404000
|
Πλεονεκτήματα του σχήματος JSON
Το JSON έχει σχεδιαστεί για να εκτρέπεται σε γλώσσα αναγνώσιμη από τον άνθρωπο και τη μηχανή. Ωστόσο, χωρίς κάποια τελειοποίηση, δεν μπορεί να είναι κανένα από τα δύο. Το JSON Schema έχει το πλεονέκτημα ότι κάνει το JSON πιο κατανοητό τόσο για μηχανές όσο και για ανθρώπους.
Η χρήση του σχήματος JSON καταργεί επίσης την ανάγκη για πολλές ενημερώσεις από την πλευρά του πελάτη. Η δημιουργία μιας λίστας κοινών κωδίκων HTML και στη συνέχεια η εφαρμογή τους στην πλευρά του πελάτη είναι μια τυπική αλλά ανακριβής μέθοδος για την κατασκευή από την πλευρά του πελάτη API εφαρμογές. Ωστόσο, αυτή δεν είναι η καλύτερη στρατηγική, επειδή οι αλλαγές στην πλευρά του διακομιστή ενδέχεται να προκαλέσουν δυσλειτουργία ορισμένων λειτουργιών.
Το κύριο πλεονέκτημα του JSON Schema είναι η συμβατότητά του με μια ποικιλία γλωσσών προγραμματισμού, καθώς και η ακρίβεια και η συνέπεια της επικύρωσης.
Το σχήμα JSON υποστηρίζει ένα ευρύ φάσμα προγραμμάτων περιήγησης και λειτουργικά συστήματα, επομένως οι εφαρμογές που είναι γραμμένες σε JSON δεν καταβάλλουν μεγάλη προσπάθεια για να γίνουν όλες συμβατές με το πρόγραμμα περιήγησης. Κατά την ανάπτυξη, οι προγραμματιστές εξετάζουν πολλά προγράμματα περιήγησης, αν και το JSON έχει ήδη τις δυνατότητες.
Το JSON είναι ο πιο αποτελεσματικός τρόπος κοινής χρήσης δεδομένων οποιουδήποτε μεγέθους, συμπεριλαμβανομένων ήχου, βίντεο και άλλων μέσων. Αυτό οφείλεται στο γεγονός ότι το JSON αποθηκεύει δεδομένα σε πίνακες, γεγονός που διευκολύνει τη μετάδοση δεδομένων. Ως αποτέλεσμα, το JSON είναι η καλύτερη μορφή αρχείου για διαδικτυακά API και ανάπτυξη.
Καθώς τα API γίνονται πιο κοινά, είναι λογικό να υποθέσουμε ότι η επικύρωση και η δοκιμή API θα γίνονται όλο και πιο σημαντικές. Είναι επίσης ρεαλιστικό να περιμένουμε ότι το JSON δεν είναι πιθανό να γίνει πολύ πιο απλό όσο περνάει ο καιρός. Αυτό σημαίνει ότι η ύπαρξη ενός σχήματος για τα δεδομένα σας θα γίνεται πιο κρίσιμο όσο περνά ο καιρός. Επειδή το JSON είναι η τυπική μορφή αρχείου για εργασία με API, το JSON Schema είναι ένα καλό υποκατάστατο για όσους εργάζονται με API.
