Importing OpenAPI / Swagger
This is Restorm’s most complete import. Three versions are recognised: Swagger 2.0, OpenAPI 3.0 and OpenAPI 3.1.
Importing
Section titled “Importing”File ▸ Import (Ctrl+I), then a swagger.json / openapi.json file, or the
specification’s URL directly.
If the URL answers 401 or 403, Restorm offers to attach an authentication and
retry, without leaving the import modal.
What is imported
Section titled “What is imported”| Element of the specification | What Restorm makes of it |
|---|---|
servers (or host + basePath + schemes) | The environment’s base URL, with server variables resolved |
tags | One folder per tag, plus an Other folder for the rest |
| Each operation | An HTTP request, method and path included |
| Parameters | Path, query and header parameters, typed (string, number, date time, enumeration, secret…) |
requestBody | The body, in its content type |
examples | The body pre-filled with the example supplied |
components / definitions | The API documentation: models, descriptions |
enum | Enumerations reusable as a value type |
| Responses | Documented per content type |
$refs are resolved, including across components.
The components / definitions row deserves emphasis: the import is not limited
to requests, it keeps the API’s whole documentation — descriptions, models,
security schemes, examples, enumerations. It is browsable in the Docs tab of
the environment folder produced by the import as well as in each request’s own,
and it re-syncs from the source. See
Accessing and updating an imported API’s documentation.
Security
Section titled “Security”The security schemes declared are translated into pre-wired headers or parameters, with the matching environment variable created for you:
| Scheme | What Restorm sets up |
|---|---|
apiKey in a header or in the query | A pair named after the scheme, value {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
All that is left is to fill in the variable — or to replace it with an authentication route to benefit from automatic renewal.
Updating
Section titled “Updating”OpenAPI and Swagger are among the re-syncable formats: the folder’s Refresh button fetches the source and Restorm applies the delta — new operations added, vanished operations marked deprecated rather than deleted, your edits kept. See Updating from the source.