Swagger
The Swagger connector supports a swagger file with the following authentication types: Basic, OAuth, and App Key. This connector supports OpenAPI 2.0 and OpenAPI 3.0 specifications.
Connector Release Version
Swagger connector was delivered in the 8.4.3 release.
Supported Action
Supported Triggers
None
Supported Authorizations
Swagger connector supports the following authorization:
• None
• Basic
• OAuth
 |
Before adding an OAuth connection, ensure that you follow the steps provided in Obtaining Client Id and Client Secrets for Swagger.
|
• App Key
Authorize Swagger
Swagger authorization must be done for each Swagger connector action. From the authentication scheme list, select one of the authorization schemes:
• None—Provide the Swagger file URL such as https://petstore.swagger.io/v2/swagger.json
• Basic—To add a basic connection, do the following:
1. From the authentication scheme list, select Basic.
2. In the Swagger Connection field, click Add New.
3. In the Add Connection window, enter the following details:
▪ Connection Label—Autopopulated. You can provide the connection label of your choice.
|
|
Labels are case-sensitive. Do not use spaces, some special characters, and leading numbers.
|
▪ Swagger Url—Swagger.json file Url.
▪ Username—User name for the target application.
▪ Password—Password for the target application.
4. Click ADD. A new authorization is added to the list.
• OAuth—To add an OAuth connection, do the following:
Prerequisite—Before adding a new OAuth connection, make sure that you follow the steps provided in the Swagger section in the topic Configuring Connector OAuth Settings.
1. From the authentication scheme list, select OAuth.
2. In the Swagger OAuth field, click Add new Swagger login.
3. On the Parameters window, enter the Swagger URL, and then click ALLOW. The Add Authorization window opens.
4. In the Add Authorization window, edit the Authorization Label, if needed and then enter the resource URL.
5. Click ADD.
• App Key—To add a new app key connection, do the following:
1. From the authentication scheme list, select App Key.
2. In the Swagger AppKey field, click Add New.
3. In the Add Connection window, enter the following details:
▪ Connection Label—Autopopulated. You can provide the connection label of your choice.
|
|
Labels are case-sensitive. Do not use spaces, some special characters, and leading numbers.
|
▪ Swagger Url—Swagger.json file URL such as https://petstore.swagger.io/v2/swagger.json
▪ App Key—Enter the Swagger App Key.
4. Click ADD.
|
|
Click TEST to validate the authorization.
|
Swagger Connector Limitations
• In OpenAPI 3.0 specification, the server field has an option of defining multiple base URLs. The current implementation does not support this option instead the first base URL is taken from the server array.
• The following media types are allowed in the request: application/json and application/x-www-form-urlencoded. Wildcard is not allowed. For the response, application/json is allowed.
• File or image upload and download is not supported.
• Multipart or form data is not supported.
• Parameter serialization method is default for all the parameters.
• Use of “one of”, “anyOf”, “allOf”, and “not” is not supported in the type field.
• Multiple authentication is not allowed. All the APIs should have similar authentication.