The best way to document your APIs & share APIs
August 10, 2021

The best way to document your APIs & share APIs

Anonymous | TrustRadius Reviewer
Score 10 out of 10
Vetted Review
Verified User
Review Source

Overall Satisfaction with SwaggerHub

Ours is a small startup; our product is still under development. We use SwaggerHub to document all our APIs. Try & execute the APIs from the console instead of using CURL or something. Always helps in checking our backend APIS calls and see how the APIs are functioning. A very handy tool.
  • The UI & easy of integration with Bitbucket & other repositories.
  • It is easy to document your API using Swagger 2.0 or Open API specification.
  • You can use the "Try It Out" button and invoke API, authenticate and execute the APIs.
  • It also has ways to integrate AWS API gateway, Bitbucket, Github & other tools.
  • Helps streamline the development especially sharing APIs across multiple departments & developers.
  • It doesn't have a way to write test cases like Postman has.
  • It does't have environments to configure different ENV variables like Postman has.
  • And may be having a client app for Swagger would be nice to have.
  • API documentation & specification
  • Testing the APIs directly using the SwaggerHub UI.
  • Committing the new API definitions to Bitbucket & also AWS API gateway using the SwaggerHub integrations.
  • We used the free version, our API is public if you know the URL.
  • It definitely helped us a lot & helped save a lot of time in speeding up the development.
  • It also helped us with testing the API and brought us more clarity on the use cases we need to address.
The only other product we looked at was Postman. But we liked the SwaggerHub UI & the integrations it has with the AWS API gateway. Though Postman has some other great features like the ability to write test cases & execute them, SwaggerUI was more convenient to document & share them.

Do you think SwaggerHub delivers good value for the price?

Yes

Are you happy with SwaggerHub's feature set?

Yes

Did SwaggerHub live up to sales and marketing promises?

Yes

Did implementation of SwaggerHub go as expected?

Yes

Would you buy SwaggerHub again?

Yes

It is always best to write your API specification first, using Open API 3 specification or SwaggerHub 2.0.
A clearly defined API definition will help streamline your development process & also help your QA understand all the different use cases. APIs can be individually tested with different models directly inside the SwaggerHub UI. If you plan to write test cases, SwaggerHub may not be of much help, but it does a great job at what it has. I definitely recommend SwaggerHub for API documentation, very to easy to use UI, and sharing your docs public. You can use the "Try It Out Button" to invoke API and authenticate and execute the APIs.

SwaggerHub Feature Ratings

API access control
10
Rate limits and usage policies
6
API usage data
6
API user onboarding
10
API versioning
10
Usage billing and payments
Not Rated
API monitoring and logging
5

Using SwaggerHub

4 - IOS developer
Business analyst
Backend engineer
QA
1 - It's just me that writes the API. Any API developer can use it if they know a little bit about API Specification using YAML or JSON.
  • API specification
  • API documentation
  • API integration
  • API First development. We wrote the API specification even before implementing
  • Testing the APIs directly from SwaggerHub.
  • Creating AWS Lambda functions using SwaggerHub integrations.