Ενημέρωση από την πηγή
Μια προδιαγραφή API ζει. Μια επανεισαγωγή που θα τα έσβηνε όλα θα σας έκανε να χάσετε τις προσαρμογές σας· μια επανεισαγωγή δίπλα θα παρήγαγε διπλότυπο. Το Restorm κάνει το τρίτο: υπολογίζει τη διαφορά.
Πώς λειτουργεί
Section titled “Πώς λειτουργεί”Κάθε επιτυχημένη εισαγωγή καταγράφει ένα αποτύπωμα της πηγής στον φάκελο μεταβλητών που δημιουργήθηκε. Το κουμπί Ανανέωση του φακέλου ανακτά την πηγή, συγκρίνει τα αποτυπώματα και εφαρμόζει τις διαφορές αντί να ξεκινήσει από το μηδέν:
- οι νέες λειτουργίες προστίθενται, στο σημείο όπου θα τις τοποθετούσε μια καινούργια εισαγωγή·
- οι τροποποιημένες λειτουργίες βλέπουν τις παραμέτρους τους να συμπληρώνονται με ό,τι προσθέτει η προδιαγραφή·
- οι λειτουργίες που η προδιαγραφή σημαίνει ως παρωχημένες επισημαίνονται και εμφανίζονται ξεθωριασμένες στο δέντρο·
- οι λειτουργίες που εξαφανίστηκαν από την πηγή επισημαίνονται ως αφαιρεθείσες και εμφανίζονται διαγραμμένες — παραμένουν εκτελέσιμες και δεν διαγράφονται ποτέ·
- οι τροποποιήσεις σας διατηρούνται: όνομα, μέθοδος, διεύθυνση URL και οι τιμές που εισαγάγατε δεν αντικαθίστανται ποτέ.
Η αρχή: η προδιαγραφή έχει την τελευταία λέξη για ό,τι περιγράφει, εσείς έχετε την τελευταία λέξη για τα υπόλοιπα.
Η πλήρης ροή — πού βρίσκεται το κουμπί, τι δείχνει ο οδηγός πριν από την εφαρμογή, τι συμβαίνει στην τεκμηρίωση — περιγράφεται στο Πρόσβαση και ενημέρωση της τεκμηρίωσης ενός εισαγόμενου API.
Επανασυγχρονίσιμες μορφές
Section titled “Επανασυγχρονίσιμες μορφές”Αφορά δώδεκα μορφές:
- OpenAPI 3.x
- Swagger 2.0 (ίδια σελίδα με την προηγούμενη, αλλά μετριέται χωριστά εδώ: οι δύο έχουν τη δική τους λογική επανασυγχρονισμού)
- GraphQL (SDL)
- gRPC — αρχείο
.protoκαι αντανάκλαση διακομιστή - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Μη επανασυγχρονίσιμες μορφές
Section titled “Μη επανασυγχρονίσιμες μορφές”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
Για αυτές, μια νέα εισαγωγή δημιουργεί νέο δέντρο: εναπόκειται σε εσάς να συνδυάσετε τα δύο, ή να κάνετε την εισαγωγή σε έναν ειδικό φάκελο.
Ειδική περίπτωση: gRPC με αντανάκλαση
Section titled “Ειδική περίπτωση: gRPC με αντανάκλαση”Ένα αίτημα gRPC που εισήχθη με αντανάκλαση φέρει ένα κουμπί Ανανέωση από την αντανάκλαση απευθείας στην καρτέλα του: είναι ο συντομότερος δρόμος όταν μια υπηρεσία εξελίσσεται κατά τη διάρκεια της ανάπτυξης.