Importing an API Blueprint document
API Blueprint describes an API in enriched Markdown. Restorm parses it with the official parser (Drafter), compiled to WebAssembly and embedded: no external tool is required.
Importing
Section titled “Importing”File ▸ Import (Ctrl+I) then the .apib file, or pasted content beginning
with FORMAT: 1A.
What is imported
Section titled “What is imported”| Element | What Restorm makes of it |
|---|---|
| Resource groups | Folders |
| Each transition | An HTTP request |
| Parameters | Typed |
| The server’s URL | The environment’s base URL |
| Descriptions and models | The API documentation |
Several examples per transition
Section titled “Several examples per transition”An API Blueprint transition can declare several + Request / + Response pairs.
Restorm creates one request per pair, with an index suffix (#1, #2…) to
tell them apart.