The best way to document your APIs & share APIs
Use Cases and Deployment Scope
Pros
- 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.
Cons
- 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.
Likelihood to Recommend
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.
