Integrations
API Hub for Design integrates with other development and API-related tools, which allows you to connect your API definitions to your existing toolset. For example, you can push API definitions to source control from API Hub for Design, generate API mocks or create webhooks to trigger your own workflows.
Integrations are configured for each API version individually. However, some integrations can be carried over when you create a new API version.
Supported integrations
OpenAPI
Below is a list of tools API Hub for Design integrates with, and the OpenAPI Specification versions that each integration supports.
Integration | OAS 2 | OAS 3 |
|---|---|---|
Mocking | ||
✓ | ✓ | |
Source control (Git) | ||
(formerly Team Foundation Server, or TFS) | ||
(formerly Visual Studio Team Services, or VSTS) | ✓ | ✓ |
Bitbucket Cloud (bitbucket.org) | ✓ | ✓ |
Bitbucket Server (formerly Stash) | ✓ | ✓ |
✓ | ✓ | |
✓ | ✓ | |
✓ | ✓ | |
✓ | ✓ | |
✓ | ✓ | |
IDEs | ||
✓ | ✓ | |
✓ | ✓ | |
Build tools | ||
✓ | ✓ | |
✓ | ✓ | |
API management platforms | ||
✓ | ✓ | |
✓ | ✓ | |
✓ | ✓ | |
✓ | ✓ | |
✓ | ||
Miscellaneous | ||
✓ | ✓ | |
AsyncAPI
The following integrations are supported for AsyncAPI (SaaS only):
Bitbucket Cloud (bitbucket.org)
Bitbucket Server (formerly Stash)
Add and manage integrations
You can view API integrations in the API Hub for Design editor. To add or edit integrations, you must have the role of an Owner or Designer.
Open the API in the API Hub for Design editor.
If the API has several versions, select the version the integrations of which you want to manage.
Click the API name to open the API info panel, then switch to the Integrations tab. Here, you can see the existing integrations and add new ones.
Click the image to enlarge it.
Can I add multiple integrations to the same API?
Yes. For example, you can have GitHub Sync and a webhook enabled for the same API.
An API can also use multiple copies of the same integration. For example, an API can use two instances of GitHub Sync to sync client SDKs with two different GitHub repositories.
Run integrations
Integrations are triggered automatically by certain events, typically, when you save an API. You can also trigger most integrations manually by clicking the button next to an integration in the list. An integration must be enabled in order to be triggered.
Enable and disable integrations
You can disable the integrations temporarily if you do not want to use them. To enable or disable an integration, open integration settings and select or clear the Enabled check box at the bottom:
Click the image to enlarge it.
Disabled integrations have the "power off" icon in the list of integrations.
Troubleshooting
Integration failures are indicated by an error message at the top of the editor. Click the message to view a list of failed integrations and the error details.
Click the image to enlarge it.
To ignore a specific error, click Hide in the error list. This will hide this error until the next integration run. Alternatively, you can disable the problematic integration until the issue is resolved.