OpenAPI and Swagger
Import OpenAPI… reads OpenAPI 3.0 and 3.1 and Swagger 2.0, as JSON or YAML. Nothing is fetched from the network:
$ref must point inside the file.
What you get
Section titled “What you get”- A folder for each operation’s first tag, and a request for each operation, such as
{{baseUrl}}/pets/{{petId}}. - Path parameters become collection variables, with the spec’s example as their value.
- Optional query parameters are there but unticked.
- An example body, and auth from the spec’s security scheme.
- Two checks on each request: the success status, and Body matches schema.
- One environment for each server in the spec. A server whose name looks like production is marked as production.
Update from OpenAPI
Section titled “Update from OpenAPI”When the spec changes, Update from OpenAPI… compares it with the one you imported. Requests are matched by method and the shape of the URL, so a renamed request is still found. New operations become new requests and new required parameters are added. Nothing is deleted; the report lists what else changed.