Mengimpor dokumen API Blueprint
API Blueprint menggambarkan sebuah API dalam Markdown yang diperkaya. Restorm menguraikannya dengan parser resminya (Drafter), yang dikompilasi ke WebAssembly dan disertakan: tidak ada alat eksternal yang dibutuhkan.
Mengimpor
Section titled “Mengimpor”File ▸ Impor (Ctrl+I) lalu pilih file .apib, atau konten tempelan yang
diawali FORMAT: 1A.
Apa yang diimpor
Section titled “Apa yang diimpor”| Elemen | Yang dibuat Restorm darinya |
|---|---|
| Grup sumber dayanya | Folder |
| Setiap transisi | Sebuah permintaan HTTP |
| Parameternya | Bertipe |
| URL servernya | URL dasar lingkungannya |
| Deskripsi dan model | Dokumentasi API |
Beberapa contoh per transisi
Section titled “Beberapa contoh per transisi”Sebuah transisi API Blueprint dapat mendeklarasikan beberapa pasangan
+ Request / + Response. Restorm membuat satu permintaan per pasangan,
dengan akhiran indeks (#1, #2…) untuk membedakannya.