Przejdź do głównej zawartości

Import dokumentu API Blueprint

API Blueprint opisuje API w rozszerzonym Markdownie. Restorm analizuje go oficjalnym parserem (Drafter), skompilowanym do WebAssembly i osadzonym w aplikacji: żadne zewnętrzne narzędzie nie jest potrzebne.

Plik ▸ Importuj (Ctrl+I), a następnie plik .apib albo wklejona treść zaczynająca się od FORMAT: 1A.

ElementCo Restorm z tego tworzy
Grupy zasobówFoldery
Każde przejścieŻądanie HTTP
ParametryOtypowane
Adres URL serweraBazowy adres URL środowiska
Opisy i modeleDokumentacja API

Przejście w API Blueprint może deklarować kilka par + Request / + Response. Restorm tworzy jedno żądanie na parę, z sufiksem indeksu (#1, #2…) pozwalającym je rozróżnić.