When we originally conceived of SwaggerHub, we knew that it was vital to have meaningful integrations right from the start. Our integrations focus on the core goals of making SwaggerHub your choice for designing, building and exposing API definitions. As an API-driven product itself, SwaggerHub is the perfect connector to other API-driven tools through our open API infrastructure.
SwaggerHub Registry API
As the canonical listing of Swagger APIs, we want to make that information available as broadly as possible. To make it easy for people to use this information in their own applications, we built a Registry API (oh, and of course added it to the Registry…very meta).
With the SwaggerHub Registry API, you can:
- Search APIs.
- Get Swagger definitions in JSON/YAML format.
- Add Swagger definitions/version (you’ll need an API Key to do this).
Link to DockerHub
If you have made your API available as a Docker container, the next step is to make it very easy for people to find and consume your API. That’s why we include a DockerHub link as part of your API info in SwaggerHub. Just enter the endpoint for your API’s DockerHub container and we’ll make sure the DockerHub whalesay icon shows up next to your listing in the Registry. Clicking the icon brings users directly to your listing in DockerHub.
Integrate with GitHub
We know it’s important to keep your API definitions in your own repository with the rest of your assets. When you create your API, enter the link to your GitHub repository as part of your API information. Then, after you’ve merged the contributions from your collaborators and you feel you have something ready to commit, use the Push to GitHub option to commit the current version of the API definition to your private or shared repository.
Ready! API Plugin
Testing is key to having a successful well-loved API. So, to accommodate that portion of your API's lifecycle, we built a plugin for Ready! API that allows you to import APIs from SwaggerHub to use in your testing. Importing APIs reads in the Swagger definition and lets you create a variety of tests based on that API definition. But you can also go the other way - when your tests pass, publish your API to SwaggerHub so your collaborators can see it and consumers can find it on our Registry. To find the free plugin, just look in the Plugin Manager inside Ready! API.