Een API Blueprint-document importeren
API Blueprint beschrijft een API in verrijkte Markdown. Restorm parseert die met de officiële parser (Drafter), gecompileerd naar WebAssembly en meegeleverd: u hebt geen externe tool nodig.
Importeren
Section titled “Importeren”Bestand ▸ Importeren (Ctrl+I) en daarna het .apib-bestand, of geplakte inhoud
die met FORMAT: 1A begint.
Wat er wordt geïmporteerd
Section titled “Wat er wordt geïmporteerd”| Element | Wat Restorm daarmee doet |
|---|---|
| De resourcegroepen | Mappen |
| Elke transitie | Een HTTP-verzoek |
| De parameters | Getypeerd |
| De URL van de server | De basis-URL van de omgeving |
| Beschrijvingen en modellen | De API-documentatie |
Meerdere voorbeelden per transitie
Section titled “Meerdere voorbeelden per transitie”Een API Blueprint-transitie kan meerdere paren + Request / + Response declareren.
Restorm maakt daar één verzoek per paar van, met een indexachtervoegsel (#1,
#2…) om ze te onderscheiden.