Ein API-Blueprint-Dokument importieren
API Blueprint beschreibt eine API in angereichertem Markdown. Restorm analysiert sie mit dem offiziellen Parser (Drafter), kompiliert zu WebAssembly und eingebettet: Es ist kein externes Werkzeug erforderlich.
Importieren
Section titled “Importieren”Datei ▸ Importieren (Ctrl+I), dann die .apib-Datei, oder eingefügter
Inhalt, der mit FORMAT: 1A beginnt.
Was importiert wird
Section titled “Was importiert wird”| Element | Was Restorm daraus macht |
|---|---|
| Die Ressourcengruppen | Ordner |
| Jeder Übergang (Transition) | Eine HTTP-Anfrage |
| Die Parameter | Typisiert |
| Die Server-URL | Die Basis-URL der Umgebung |
| Beschreibungen und Modelle | Die API-Dokumentation |
Mehrere Beispiele pro Übergang
Section titled “Mehrere Beispiele pro Übergang”Ein API-Blueprint-Übergang kann mehrere Paare aus
+ Request / + Response deklarieren. Restorm erstellt daraus eine
Anfrage pro Paar, mit einem Index-Suffix (#1, #2 …) zur Unterscheidung.