Git

Blackbird integrates with Git to simplify how you discover, import, and manage your APIs. When you connect your GitHub repositories, Blackbird can automatically detect OpenAPI and Swagger definitions and import them directly into your Blackbird catalog. As your API specifications evolve in GitHub, Blackbird stays in sync to ensure that your definitions are always up to date.

Key features include:

• GitHub API discovery – Scan your private and public GitHub repositories for OpenAPI and Swagger definitions.
• Github API importing – Import API definitions you select into Blackbird. When changes are made to the API specification in GitHub, Blackbird automatically updates the imported version.

Prerequisites

Before configuring the Git integration, ensure you meet the following requirements:

• You have a GitHub account.
• To import API definitions from private repositories, you must have access permissions. If you aren't an administrator, your GitHub administrator must approve adding the Blackbird app. To import API definitions from public repositories, you don't need administrator approval. You can connect and add public API specifications directly.

Configure the Git integration

After you meet the prerequisites, use the following procedure to configure the Git integration.

To configure the Git integration:

1. Log into the Blackbird UI.
2. In the left pane, choose APIs.
3. Choose the Add API button.
4. Choose the Import APIs from Git option.
5. Choose the Authorize Blackbird in GitHub to view and select available repositories. link to allow Blackbird to discover your public APIs in GitHub.
6. (Optional) If you only see public repositories in the Select Repository drop-down menu, choose the add the Blackbird GitHub app link. If you aren’t a GitHub administrator for your private repositories, we’ll submit a permissions request to your administrator.
7. In the Select repository drop-down menu, choose the repository you want to analyze for available APIs and then import into Blackbird, choose Import. Blackbird analyzes your repository and imports available APIs. During this process, you'll see APIs populating beneath the modal. You can close the modal at any time without interrupting the process.