HelpAddonsOpenapiOpenapi

Open API Specification Support

This add-on allows you to spider and import OpenAPI (Swagger) definitions.

The add-on will automatically detect any Open API definitions and spider them as long as they are in scope.

UI

2 menu items are added to the Tools menu:

• Import an Open API definition from the local file system
• Import an Open API definition from a URL

API

The following operations are added to the API:

• ACTION importFile (file)
• ACTION importUrl (url)

The definitions will be imported synchronously and any warnings will be returned.

Command Line

The following Command Line options are added:

• -openapifile : Import an Open API definition from the specified file name
• -openapiurl : Import an Open API definition from the specified URL

The definitions will be imported synchronously and any warnings will be displayed on the command line.