Εισαγωγή ενός εγγράφου API Blueprint
Το API Blueprint περιγράφει ένα API σε εμπλουτισμένο Markdown. Το Restorm το αναλύει με τον επίσημο αναλυτή (Drafter), μεταγλωττισμένο σε WebAssembly και ενσωματωμένο: δεν απαιτείται κανένα εξωτερικό εργαλείο.
Εισαγωγή
Section titled “Εισαγωγή”Αρχείο ▸ Εισαγωγή (Ctrl+I) και έπειτα το αρχείο .apib, ή επικολλημένο
περιεχόμενο που ξεκινά με FORMAT: 1A.
Τι εισάγεται
Section titled “Τι εισάγεται”| Στοιχείο | Τι κάνει το Restorm με αυτό |
|---|---|
| Τις ομάδες πόρων | Φακέλους |
| Κάθε μετάβαση | Ένα αίτημα HTTP |
| Τις παραμέτρους | Με τύπους |
| Τη διεύθυνση URL του διακομιστή | Τη βασική διεύθυνση URL του περιβάλλοντος |
| Περιγραφές και μοντέλα | Την τεκμηρίωση API |
Πολλά παραδείγματα ανά μετάβαση
Section titled “Πολλά παραδείγματα ανά μετάβαση”Μια μετάβαση API Blueprint μπορεί να δηλώσει πολλά ζεύγη
+ Request / + Response. Το Restorm δημιουργεί ένα αίτημα ανά ζεύγος, με
ένα επίθημα δείκτη (#1, #2…) για να τα ξεχωρίζετε.