Swagger Integration

ReadyAPI supports the following SwaggerHub versions:

• SwaggerHub SaaS

• SwaggerHub On-Premise 1.23.0-43 or later

• The SwaggerHub integration feature is included in ReadyAPI. You don't need to install any plugins.

You can add your SwaggerHub account to ReadyAPI and use it in any projects for SwaggerHub-related actions such as importing a definition.

To open the account manager, click Preferences on the main toolbar and select the SwaggerHub tab:

Click the image to enlarge it.

Add account

If you haven't set up a SwaggerHub account in ReadyAPI yet, the account manager will have the Log in to SwaggerHub button. Click the button and set up your connection:

1. If you use SwaggerHub On-Premise, select Use on-prem URL and enter the URL of your SwaggerHub instance.

2. In the Username field, enter your SwaggerHub username.

   Note:

   The SwaggerHub integration does not support logging in with a GitHub account.

3. In the API Key field, enter your API key.

   Tip:	If you click Get API Key, you will be taken to the SwaggerHub API Keys page in your web browser. You can copy your API key from there.

Note:

You can only add one SwaggerHub account to ReadyAPI.

Edit account

If you already have a SwaggerHub account added to ReadyAPI, but you want to edit it, select Edit Account:

Click the image to enlarge it.

To test if your account can connect to the server, select Test Connection.

Expand your projects by adding Swagger definitions to them. ReadyAPI supports importing definitions from SwaggerHub (both the SwaggerHub SaaS and SwaggerHub On-Premise) for public and private definitions – see Import from SwaggerHub for more information.

Use ReadyAPI to export any REST services in the OpenAPI/Swagger format (as a .json, .yaml, or .xml file), or to immediately publish them on SwaggerHub. See Exporting APIs for more information.

To ensure your service sends responses that meet the Swagger specification requirements, use the Swagger Compliance assertion in your functional tests.