Need advice about which tool to choose?Ask the StackShare community!
Swagger UI vs zeroheight: What are the differences?
Swagger UI: A Collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation. Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API; zeroheight: UX design docs that stay up-to-date. Document your design system, together. Create beautiful living styleguides and document all your design system resources in one place.
Swagger UI and zeroheight can be primarily classified as "Documentation as a Service &" tools.
Some of the features offered by Swagger UI are:
- The UI works in any development environment, be it locally or in the web
- Allow end developers to effortlessly interact and try out every single operation your API exposes for easy consumption
- Quickly find and work with resources and endpoints with neatly categorized documentation
On the other hand, zeroheight provides the following key features:
- Sync with your favorite design tools
- Add interactive HTML and Storybook code
- Write, embed and organize content
Swagger UI is an open source tool with 16.4K GitHub stars and 6.92K GitHub forks. Here's a link to Swagger UI's open source repository on GitHub.
From a StackShare Community member: "I just started working for a start-up and we are in desperate need of better documentation for our API. Currently our API docs is in a README.md file. We are evaluating Postman and Swagger UI. Since there are many options and I was wondering what other StackSharers would recommend?"
I use Postman because of the ease of team-management, using workspaces and teams, runner, collections, environment variables, test-scripts (post execution), variable management (pre and post execution), folders (inside collections, for better management of APIs), newman, easy-ci-integration (and probably a few more things that I am not able to recall right now).
I use Swagger UI because it's an easy tool for end-consumers to visualize and test our APIs. It focuses on that ! And it's directly embedded and delivered with the APIs. Postman's built-in tools aren't bad, but their main focus isn't the documentation and also, they are hosted outside the project.
I recommend Postman because it's easy to use with history option. Also, it has very great features like runner, collections, test scripts runners, defining environment variables and simple exporting and importing data.
Pros of Swagger UI
- Open Source49
- Can execute api calls from the documentation34
- Free to use29
- Customizable19
- Easy to implement in .Net14
- Mature, clean spec13
- API Visualization12
- Coverage9
- Scaffolding6
- Easy to use6
- Vibrant and active community5
- Elegant4
- Adopted by tm forum api3
- Clear for React2
- Api1
- Can deploy API to AWS API Gateway and AWS Lambda1
Pros of zeroheight
Sign up to add or upvote prosMake informed product decisions
Cons of Swagger UI
- Need to learn YAML and RAML3
- Documentation doesn't look that good2
- Doesn't generate code snippets in different languages1
- You don’t actually get in-line error highlighting1
- Does not support hypermedia1
