API Blueprint -dokumentin tuonti
API Blueprint kuvaa API:n rikastetulla Markdownilla. Restorm jäsentää sen virallisella jäsentimellä (Drafter), joka on käännetty WebAssemblyksi ja sisällytetty sovellukseen: ulkoisia työkaluja ei tarvita.
Tuonti
Section titled “Tuonti”Tiedosto ▸ Tuo (Ctrl+I) ja sitten .apib-tiedosto tai liitetty sisältö,
joka alkaa merkinnällä FORMAT: 1A.
Mitä tuodaan
Section titled “Mitä tuodaan”| Elementti | Mitä Restorm tekee siitä |
|---|---|
| Resurssiryhmät | Kansiot |
| Jokainen siirtymä | HTTP-pyyntö |
| Parametrit | Tyypitettyinä |
| Palvelimen URL | Ympäristön perus-URL |
| Kuvaukset ja mallit | API-dokumentaatio |
Useita esimerkkejä siirtymää kohti
Section titled “Useita esimerkkejä siirtymää kohti”API Blueprint -siirtymä voi ilmoittaa useita
+ Request / + Response -pareja. Restorm luo niistä yhden pyynnön paria
kohti ja erottaa ne indeksijälkiliitteellä (#1, #2…).