Ο σχεδιαστής API
Ο σχεδιαστής API σας επιτρέπει να σχεδιάσετε ένα πλήρες API απευθείας μέσα στο Restorm: περιγράφετε τα δεδομένα σας και τις διαδρομές σας, και το Restorm αναλαμβάνει τα υπόλοιπα — σερβίρει το σχέδιό σας σαν έναν πραγματικό διακομιστή mock, και παράγει τον κώδικα της εφαρμογής σας από πρότυπα.
Είναι το ιδανικό εργαλείο για να ξεκινήσετε ένα API πριν ακόμη υπάρξει το back-end: φτιάξτε τη μακέτα του συμβολαίου, δώστε το στους πελάτες σας να το δοκιμάσουν, και κρατήστε τα πάντα με έλεγχο εκδόσεων μέσα στο έργο σας.
Ένα σχέδιο, πολλές ενότητες
Section titled “Ένα σχέδιο, πολλές ενότητες”Ένα σχέδιο δημιουργείται όπως οποιοδήποτε άλλο στοιχείο: δεξί κλικ σε έναν φάκελο ▸ Προσθήκη ▸ Σχέδιο API. Ανοίγει στη δική του καρτέλα και συγκεντρώνει πολλές ενότητες, προσβάσιμες από την πλαϊνή μπάρα:
| Ενότητα | Σε τι χρησιμεύει |
|---|---|
| Μοντέλα | Οι οντότητές σας και οι ιδιότητές τους — δείτε Μοντέλα, enums και ιδιότητες. |
| Enums | Κλειστά σύνολα τιμών, επαναχρησιμοποιήσιμα ως τύπος ιδιότητας. |
| Διαδρομές | Τα σημεία εισόδου του API, ομαδοποιημένα ανά πόρο — δείτε Διαδρομές & CRUD. |
| Διακομιστής | Σερβίρισμα του σχεδίου ως mock, σε HTTP, GraphQL, SOAP, OData ή gRPC — δείτε Σερβίρισμα του σχεδίου ως mock. |
| Πελάτες | Έτοιμα προς χρήση αιτήματα που καλούν το mock που εκτελείται — δείτε Πελάτες. |
| Τεκμηρίωση & Σημειώσεις | Τεκμηρίωση και ελεύθερες σημειώσεις συνδεδεμένες με το σχέδιο. |
| Κώδικας | Η παραγωγή κώδικα από τα πρότυπά σας — δείτε Παραγωγή κώδικα. |
Οι ρυθμίσεις του σχεδίου (όνομα, προεπιλεγμένες τιμές) ανοίγουν κάνοντας κλικ απευθείας στον κόμβο του σχεδίου στην πλαϊνή μπάρα.
Η τυπική πορεία
Section titled “Η τυπική πορεία”- Περιγράψτε τα δεδομένα σας — δημιουργήστε τα μοντέλα και τα enums σας, προσθέστε τις ιδιότητές τους, τους τύπους τους και τους περιορισμούς τους.
- Ορίστε τις διαδρομές σας — με το χέρι, ή με ένα κλικ με το Παραγωγή CRUD από ένα μοντέλο.
- Σερβίρετε το mock — εκκινήστε τον διακομιστή και στρέψτε την εφαρμογή σας ή έναν πελάτη πάνω του. Το ίδιο σχέδιο προβάλλεται αυτόματα σε κάθε ενεργοποιημένο πρωτόκολλο.
- Παράξτε τον κώδικα — επιλέξτε ένα ή περισσότερα πρότυπα (τα δικά σας ή αυτά που προσφέρει το Restorm) και παράξτε το αντίστοιχο έργο.
Κάθε βήμα περιγράφεται λεπτομερώς στις σελίδες αυτής της ενότητας.