Need advice about which tool to choose?Ask the StackShare community!
jsdoc vs Swagger UI: What are the differences?
jsdoc and Swagger UI belong to "Documentation as a Service & Tools" category of the tech stack.
Rainist, Zalando, and Hootsuite are some of the popular companies that use Swagger UI, whereas jsdoc is used by commonality, Clovis, and MEGA Limited. Swagger UI has a broader approval, being mentioned in 205 company stacks & 107 developers stacks; compared to jsdoc, which is listed in 7 company stacks and 12 developer stacks.
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 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.
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.
Pros of jsdoc
- Far less verbose2
- Simpler type safe than TypeScript1
- No compiler needed1
- Does almost everything TS does1
Pros of Swagger UI
- Open Source48
- Can execute api calls from the documentation34
- Free to use29
- Easy to implement in .Net14
- Mature, clean spec13
- API Visualization12
- Easy to use6
- Vibrant and active community5
- Adopted by tm forum api3
- Clear for React2
- Can deploy API to AWS API Gateway and AWS Lambda1
Sign up to add or upvote prosMake informed product decisions
Cons of jsdoc
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