DepthFeed.

Ένα προϊόν δεδομένων αγοράς πρέπει να κάνει περισσότερα από το να επιστρέψει μια τιμή. Ένας ερευνητής πρέπει να ανακαλύψει μια αγορά, να επιλέξει το σωστό identifier, να κατανοήσει τι έχει καταγραφεί και να ανακτήσει μια χρησιμοποιήσιμη ιστορία. Ο ιστότοπος, η τεκμηρίωση και το API πρέπει να εξηγούν το ίδιο contract.

Το DepthFeed φέρνει metadata αγοράς προβλέψεων και καταγεγραμμένη ιστορία order-book σε ένα προϊόν για ανακάλυψη και έρευνα. Η τεκμηρίωσή του κάνει μια σημαντική διάκριση: ένα endpoint που επιστρέφει επιτυχώς δεν αποδεικνύει ότι τα βασικά δεδομένα είναι πλήρη.

Το έργο χωρίζει τα serving APIs, τη συλλογή και την ιστορική ingestion, τον δημόσιο ιστότοπο και την εμπειρία λογαριασμού, και τα παραδείγματα client. Αυτός ο διαχωρισμός επιτρέπει στη δημόσια εξήγηση και στην υλοποίηση να εξελίσσονται γύρω από ορισμένες interfaces.

Η τεκμηριωμένη ενσωμάτωση περιλαμβάνει ανακάλυψη REST και ιστορικό, με κανονικοποιημένα βιβλία WebSocket και τιμές. Η πολιτική λογαριασμού, οι αναγνωριστικοί κωδικοί, οι δείκτες (cursors) και οι χρονικές σφραγίδες παραμένουν ρητά καθορισμένα, ώστε ο πελάτης να μην χρειάζεται να συμπεράνει πώς λειτουργεί η υπηρεσία.

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

Αυτή είναι μια απόφαση σχεδιασμού προϊόντος εξίσου με την μηχανική της. Ο χρήστης πρέπει να γνωρίζει τι μπορεί να υποστηρίξει μια εγγραφή πριν χτίσει πάνω σε αυτήν μια σύγκριση ή ανάλυση. Οι σαφείς καταστάσεις είναι πιο χρήσιμες από την παρουσίαση αβέβαιων πληροφοριών ως δεδομένων.

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

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

Η δημόσια τεκμηρίωση προϊόντος και ενσωμάτωσης του DepthFeed δείχνει πώς ταιριάζουν οι εγγραφές αγοράς, ένα API και μια διεπαφή έρευνας. Οι παρακάτω συνδέσεις παρέχουν το τρέχον πλαίσιο προϊόντος και την αναφορά ενσωμάτωσης.

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