Need advice about which tool to choose?Ask the StackShare community!

jsdoc

102
131
+ 1
5
Swagger UI

1.5K
1.4K
+ 1
201
Add tool

jsdoc vs Swagger UI: What are the differences?

Developers describe jsdoc as "An API documentation generator for JavaScript". JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you. On the other hand, Swagger UI is detailed as "dependency-free 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.

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.

Advice on jsdoc and Swagger UI
Needs advice
on
PostmanPostmanApiaryApiary
and
Swagger UISwagger UI

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?"

See more
Replies (3)
Jagdeep Singh
Tech Lead at ucreate.it · | 8 upvotes · 186.7K views

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).

See more

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.

See more
Sadik Ay
Recommends
PostmanPostman

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.

See more
Get Advice from developers at your company using Private StackShare. Sign up for Private StackShare.
Learn More
Pros of jsdoc
Pros of Swagger UI
  • 2
    Far less verbose
  • 1
    Simpler type safe than TypeScript
  • 1
    No compiler needed
  • 1
    Does almost everything TS does
  • 46
    Open Source
  • 34
    Can execute api calls from the documentation
  • 28
    Free to use
  • 19
    Customizable
  • 14
    Easy to implement in .Net
  • 13
    Mature, clean spec
  • 11
    API Visualization
  • 9
    Coverage
  • 6
    Easy to use
  • 6
    Scaffolding
  • 5
    Vibrant and active community
  • 4
    Elegant
  • 3
    Adopted by tm forum api
  • 2
    Clear for React
  • 1
    Can deploy API to AWS API Gateway and AWS Lambda

Sign up to add or upvote prosMake informed product decisions

Cons of jsdoc
Cons of Swagger UI
    Be the first to leave a con
    • 2
      Need to learn YAML and RAML
    • 1
      Doesn't generate code snippets in different languages
    • 1
      Documentation doesn't look that good
    • 1
      You don’t actually get in-line error highlighting
    • 1
      Does not support hypermedia

    Sign up to add or upvote consMake informed product decisions

    - No public GitHub repository available -

    What is jsdoc?

    JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you.

    What is Swagger UI?

    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

    Need advice about which tool to choose?Ask the StackShare community!

    What companies use jsdoc?
    What companies use Swagger UI?
    See which teams inside your own company are using jsdoc or Swagger UI.
    Sign up for Private StackShareLearn More

    Sign up to get full access to all the companiesMake informed product decisions

    What tools integrate with jsdoc?
    What tools integrate with Swagger UI?
      No integrations found

      Sign up to get full access to all the tool integrationsMake informed product decisions

      What are some alternatives to jsdoc and Swagger UI?
      ESDoc
      It obtains a comment called doc comment from a source code. Then it generates a document from a tag in a doc comment
      TypeScript
      TypeScript is a language for application-scale JavaScript development. It's a typed superset of JavaScript that compiles to plain JavaScript.
      Flow
      Flow is an online collaboration platform that makes it easy for people to create, organize, discuss, and accomplish tasks with anyone, anytime, anywhere. By merging a sleek, intuitive interface with powerful functionality, we're out to revolutionize the way the world's productive teams get things done.
      Postman
      It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide.
      Apiary
      It takes more than a simple HTML page to thrill your API users. The right tools take weeks of development. Weeks that apiary.io saves.
      See all alternatives