Import dokumentu API Blueprint
API Blueprint popisuje API v obohaceném Markdownu. Restorm jej analyzuje oficiálním parserem (Drafter), zkompilovaným do WebAssembly a vestavěným do aplikace: žádný externí nástroj není potřeba.
Import
Section titled “Import”Soubor ▸ Importovat (Ctrl+I) a poté soubor .apib, nebo vložený obsah
začínající na FORMAT: 1A.
Co se importuje
Section titled “Co se importuje”| Prvek | Co s ním Restorm udělá |
|---|---|
| Skupiny zdrojů | Složky |
| Každý přechod | Požadavek HTTP |
| Parametry | Typované |
| URL serveru | Základní URL prostředí |
| Popisy a modely | Dokumentace API |
Několik příkladů na jeden přechod
Section titled “Několik příkladů na jeden přechod”Přechod v API Blueprint může deklarovat několik párů + Request / + Response.
Restorm z nich vytvoří jeden požadavek na každý pár, s indexovou příponou
(#1, #2…), aby se daly rozlišit.