API Blueprint dokumentum importálása
Az API Blueprint kibővített Markdown formában írja le az API-t. A Restorm a hivatalos elemzővel (Drafter) dolgozza fel, amely WebAssembly-re fordítva be van építve az alkalmazásba: külső eszközre nincs szükség.
Importálás
Section titled “Importálás”Fájl ▸ Importálás (Ctrl+I), majd az .apib fájl, vagy FORMAT: 1A
kezdetű beillesztett tartalom.
Az importált elemek
Section titled “Az importált elemek”| Elem | Amit a Restorm készít belőle |
|---|---|
| Az erőforráscsoportok | Mappák |
| Minden átmenet (transition) | Egy HTTP-kérés |
| A paraméterek | Típusosan |
| A kiszolgáló URL-je | A környezet alap-URL-je |
| Leírások és modellek | Az API-dokumentáció |
Több példa egy átmenethez
Section titled “Több példa egy átmenethez”Egy API Blueprint átmenet több + Request / + Response párt is deklarálhat. A
Restorm páronként egy kérést hoz létre belőlük, indexutótaggal (#1,
#2…), hogy elkülöníthetők legyenek.