SwaggerHub Integration
This feature is released as beta and should not be depended upon in a production environment.
Type: External
The SwaggerHub integration lets you connect SwaggerHub API specs directly to your Service Catalog services.
Prerequisites
You need a SwaggerHub API key to authenticate your SwaggerHub account with Konnect.
Authenticate the SwaggerHub integration
- From the Service Catalog in Kong Konnect, select Integrations.
- Select SwaggerHub, then Install SwaggerHub.
- Select Authorize.
This will take you to SwaggerHub, where you can use your SwaggerHub API key to grant Konnect access to your account.
View SwaggerHub specs in Service Catalog
You can map specs to a Service Catalog service and view them in Konnect.
- From the Service Catalog in Kong Konnect, select Services.
- Select a service, then open the API Specs tab.
- Select Add API Spec.
- Choose SwaggerHub as the Source, then pick your spec and name it.
Once it’s uploaded, you can view the rendered spec on the API Specs tab in structured (UI), YAML, or JSON format, and download it in either YAML or JSON format.
Resources
Entity | Description |
---|---|
SwaggerHub API version | A SwaggerHub API version, which is the unique version identifier for a specific API spec. |
Discovery information
This integration will discover both public and private SwaggerHub APIs in the linked account.
- Discovery is supported by this integration
- Discovery is enabled by default
- Bindable entities: SwaggerHub API version
- Discovery mechanism: pull/ingestion model