Discover APIs in a GitHub repository (GitHub App)

March 27, 2024
April 4, 2024

This integration allows you to scan your GitHub repositories for OpenAPI specifications, by installing the FireTail GitHub app. This integration also creates OpenAPI specifications from static code analysis for selected languages.

1. Navigate to Integrations in the FireTail platform. Select the Create integration tab.

2. Click GitHub Repo Scanning (GH App).

3. Click Connect.

4. Select where you want to install the app to.

5. Select to install in a specific repo or all repos.

6. Click Install & Authorize.

7. You are directed to the integration form. In the My Integration field, enter a name for the integration.

8. Select an application from the dropdown, or click Create to create a new application. This is the application that will be associated with the integration. This is the application that will be associated with the integration, and new discovered APIs will be grouped in this application. When you complete the integration this adds the discovered APIs from the GitHub Repo under the FireTail application that you choose. Learn more about applications here.

9. Enter a Scan Frequency. This is how often the scan is done in seconds. The minimum is 900 seconds (15 minutes).

10. Click Submit.

The discovered APIs can be viewed by navigating to the APIs tab in the platform. Any Specifications and Findings are loaded into the platform.

Note: It can take a few minutes for the APIs to be populated into the platform.