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

Docsify

34
136
+ 1
0
Read the Docs

70
289
+ 1
22
Swagger UI

2K
1.8K
+ 1
207
Advice on Docsify, Read the Docs, 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 · 394.3K 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
on
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
Manage your open source components, licenses, and vulnerabilities
Learn More
Pros of Docsify
Pros of Read the Docs
Pros of Swagger UI
    Be the first to leave a pro
    • 13
      GitHub integration
    • 7
      Free for public repos
    • 2
      Automated Builds
    • 49
      Open Source
    • 34
      Can execute api calls from the documentation
    • 29
      Free to use
    • 19
      Customizable
    • 14
      Easy to implement in .Net
    • 13
      Mature, clean spec
    • 12
      API Visualization
    • 9
      Coverage
    • 6
      Scaffolding
    • 6
      Easy to use
    • 5
      Vibrant and active community
    • 4
      Elegant
    • 3
      Adopted by tm forum api
    • 2
      Clear for React
    • 1
      Api
    • 1
      Can deploy API to AWS API Gateway and AWS Lambda

    Sign up to add or upvote prosMake informed product decisions

    Cons of Docsify
    Cons of Read the Docs
    Cons of Swagger UI
      Be the first to leave a con
        Be the first to leave a con
        • 3
          Need to learn YAML and RAML
        • 2
          Documentation doesn't look that good
        • 1
          Doesn't generate code snippets in different languages
        • 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 -
        - No public GitHub repository available -

        What is Docsify?

        Docsify generates your documentation website on the fly without generating static html files. Instead, it loads and parses your Markdown files and displays them as a website.

        What is Read the Docs?

        It hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar.

        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 Docsify?
        What companies use Read the Docs?
        What companies use Swagger UI?

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

        What tools integrate with Docsify?
        What tools integrate with Read the Docs?
        What tools integrate with Swagger UI?

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

        What are some alternatives to Docsify, Read the Docs, and Swagger UI?
        Yesware
        It helps build lasting business relationships, right from your inbox. A sales engagement platform designed for sales professionals and account managers.
        MkDocs
        It builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose. There's a stack of good looking themes available. The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.
        Gitbook
        It is a modern documentation platform where teams can document everything from products, to APIs and internal knowledge-bases. It is a place to think and track ideas for you & your team.
        VuePress
        A minimalistic static site generator with a Vue-powered theming system, and a default theme optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub projects.
        Docusaurus
        Docusaurus is a project for easily building, deploying, and maintaining open source project websites.
        See all alternatives