The GitHub Repository API Discovery integration using Docker enables the discovery of APIs in your GitHub repositories. This method allows FireTail users to scan their repositories for OpenAPI or Swagger specifications through a Docker-based image. Additionally, static code analysis can be performed to generate OpenAPI specifications.
Key benefits:
- Use Docker to automate API discovery across multiple GitHub repositories.
- Scan for OpenAPI or Swagger specifications, or generate them via static analysis.
- Centralized API management in the FireTail platform.
The Docker image scans GitHub repositories for OpenAPI and Swagger specifications and can generate specifications using static code analysis if needed. It creates an API per repository, with the potential for multiple specifications for each API, depending on the code structure.
The integration relies on GITHUB_TOKEN and FIRETAIL_APP_TOKEN environment variables for authentication, and a configuration file (config.yml) specifies which organizations, users, or repositories to scan.Once the Docker image is run, discovered APIs and specifications are automatically loaded into the FireTail platform, where they are grouped under the relevant application.
To set up this integration, you will need:
- A GitHub account or organization with repositories to scan.
- Docker installed on your system.·GITHUB_TOKEN and FIRETAIL_APP_TOKEN for authentication.
- A configuration file (config.yml).
Once you have cloned the necessary repository and built the Docker image, you can modify the config.yml file to suit your needs and run the Docker image to initiate the scanning process.
For more detailed instructions, refer to our documentation or contact support.
