Πωλείται από Zinn Digital
Τεκμηρίωση API δοκιμασμένη από προγραμματιστές, γραμμένη απευθείας από τον κώδικά σας, η οποία επιτρέπει στους νέους μηχανικούς να ενσωματώνονται απρόσκοπτα χωρίς να χρειάζονται υποστήριξη.
Πού αποτυγχάνουν οι περισσότερες τεκμηριώσεις API
Πολλοί οδηγοί παραθέτουν τελικά σημεία (endpoints), ωστόσο παραλείπουν τις λεπτομέρειες που προκαλούν ουσιαστικά σύγχυση: πώς λειτουργεί ο έλεγχος ταυτότητας στην πράξη, ακριβή παραδείγματα αιτημάτων και αποκρίσεων, καθώς και τι σημαίνουν συγκεκριμένα σφάλματα και πώς να επιλυθούν. Όταν συμβαίνει αυτό, οι προγραμματιστές καταφεύγουν στην υποβολή αιτημάτων υποστήριξης, γεγονός που ακυρώνει τον σκοπό ύπαρξης της τεκμηρίωσης.
Η προσέγγισή μας
Δημιουργούμε απευθείας από τον πηγαίο κώδικά σας αντί να βασιζόμαστε σε υποθέσεις. Ελέγχουμε τις διαδρομές σας, τη λογική επικύρωσης και τη διαχείριση σφαλμάτων, προτού δοκιμάσουμε οι ίδιοι το API χρησιμοποιώντας ενεργά διαπιστευτήρια. Κάθε παράδειγμα στην τελική τεκμηρίωση αντιπροσωπεύει ένα πραγματικό αίτημα που στείλαμε και μια απόκριση που λάβαμε, διασφαλίζοντας ότι δεν υπάρχουν κατασκευασμένες λεπτομέρειες ή αδύνατοι κωδικοί κατάστασης.
Τι λαμβάνετε
Μορφή παράδοσης
Παρέχουμε Markdown κατάλληλο για το αποθετήριό σας, δομημένο ώστε να ταιριάζει με το OpenAPI ή έναν ιστότοπο τεκμηρίωσης, όποιο από τα δύο θα διατηρεί ενημερωμένο η ομάδα σας. Τα δείγματα κώδικα παρέχονται στις γλώσσες στις οποίες βασίζονται οι χρήστες σας και δοκιμάζονται μέσω εκτέλεσης. Μια συλλογή τύπου Postman μπορεί να συμπεριληφθεί κατόπιν αιτήματος.
Τι χρειαζόμαστε από εσάς
Πρόσβαση στο αποθετήριό σας ή στο αρχείο OpenAPI, ενεργά διαπιστευτήρια για περιβάλλον δοκιμών και τις ερωτήσεις που απαντά συχνότερα το προσωπικό υποστήριξής σας – αυτά διαμορφώνουν τη δομή του οδηγού.
Τι εξαιρείται
Αυτή η υπηρεσία καλύπτει την ακριβή τεχνική τεκμηρίωση της συμπεριφοράς του λογισμικού· τα διαφημιστικά κείμενα ή τα κείμενα μάρκετινγκ αποτελούν ξεχωριστή εργασία.
Διαδικασία και χρονοδιάγραμμα
Θα λάβετε ένα πλήρες πρώτο προσχέδιο, το οποίο μπορείτε να ελέγξετε σε σχέση με τις επαναλαμβανόμενες ερωτήσεις που διαχειρίζεται η ομάδα υποστήριξής σας. Προτιμούμε να επισημάνει ένας μηχανικός μια οριακή περίπτωση νωρίς, παρά να παραδώσουμε κάτι προσεγμένο αλλά ανακριβές. Δεδομένου ότι κάθε παράδειγμα έχει εκτελεστεί στο ενεργό σας API, τίποτα στο τελικό έγγραφο δεν είναι θεωρητικό.
Αυτό το πακέτο καλύπτει ένα πεδίο εφαρμογής τεκμηρίωσης API σταθερής τιμής που παραδίδεται σε ένα μόνο στάδιο, με έναν γύρο αναθεώρησης, για 500.99 USD και χρόνο διεκπεραίωσης 10 ημερών. Θα χρειαστεί να παράσχετε τον τομέα (domain) στον οποίο αναφέρεται η παραγγελία και τη σύνοψη των οδηγιών σας.
500,99 $
Ή πληρώστε 447,24 € · 374,54 £ με τη σημερινή ισοτιμία — η ισοτιμία κλειδώνει όταν το προσθέτετε στο καλάθι σας.
One fixed-price scope, delivered in one pass: API Documentation. - 1 revision
Παραδόθηκε σε 10 ημέρες
Περιλαμβανόμενες αναθεωρήσεις: 0
Δεν απαιτείται λογαριασμός εκ των προτέρων — ο δικός σας δημιουργείται κατά την πληρωμή. Κρατάμε τα χρήματα μέχρι να αποδεχτείτε την εργασία.
Ναι - κάθε αίτημα που αναφέρεται στην τεκμηρίωση εκτελέστηκε σε πραγματικό περιβάλλον, πράγμα που σημαίνει ότι τα παραδείγματα δείχνουν την πραγματική συμπεριφορά του λογισμικού και όχι έναν θεωρητικό σχεδιασμό.
Παρέχουμε κυρίως Markdown εντός του αποθετηρίου σας, αν και μπορούμε επίσης να παρέχουμε μια προδιαγραφή OpenAPI με συνοδευτικό υλικό αναφοράς. Και οι δύο επιλογές εξασφαλίζουν απλή συντήρηση μετά την παράδοση.
Αυτά περιλαμβάνονται πλήρως - καλύπτοντας τη δημιουργία διακριτικών, την ανανέωση, τα σενάρια λήξης κατά τη διάρκεια των περιόδων σύνδεσης και τις βασικές αιτίες πίσω από τα συνήθη εμπόδια ενοποίησης.