Discover APIs in a GitHub repository (GitHub App)

This integration allows you to scan your GitHub repositories for OpenAPI specifications by installing the FireTail GitHub app. It can also generate OpenAPI specifications through static code analysis for selected languages.

The GitHub Repository API Discovery integration allows FireTail to scan your GitHub repositories for OpenAPI specifications or generate them through static code analysis. By installing the FireTail GitHub App, you can automate the discovery of API definitions across your codebase, ensuring complete visibility and centralized API management within the FireTail platform. The integration scans individual or all repositories, pulling discovered APIs into FireTail and grouping them under your chosen application. To set up the integration:

1. Navigate to Integrations in the FireTail platform. 

2. Click GitHub Repo Scanning (GH App).

3. Select where you want to install the app.

4. Choose to install in a specific repo or all repos, then click Save.

5. You will be directed to the integration form:

• Integration Name: Enter a name for the integration.
• Enable AI Feature: Enable this feature to generate more detailed OpenAPI specifications. Note: You will need to agree to the terms and conditions.
• Application : Select an application from the dropdown, or click Create to create a new one. Discovered APIs will be grouped under this application.
• Ignore Archived Repositories: Enable to skip scanning of archived repositories.
• Delete Archived Repository: Enable to remove APIs associated with archived repositories from the FireTail platform, including all specifications and findings.
• Scan Frequency: Enter the scan interval (minimum is 15 minutes).

6. Click Submit.

Viewing Discovered APIs:

Navigate to APIs or Applications in the platform to view discovered APIs. Any Specifications and Findings are automatically loaded.

Note: It may take a few minutes for the APIs to populate into the platform.