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

Read the Docs

64
250
+ 1
22
ReadMe.io

104
306
+ 1
69
Swagger UI

1.8K
1.5K
+ 1
204
Advice on Read the Docs, ReadMe.io, 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 · 244.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
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 Read the Docs
Pros of ReadMe.io
Pros of Swagger UI
  • 13
    GitHub integration
  • 7
    Free for public repos
  • 2
    Automated Builds
  • 18
    Great UI
  • 15
    Easy
  • 10
    Customizable
  • 10
    Cute mascot
  • 8
    Looks great and is fun to use
  • 5
    It's friggin awesome
  • 3
    Make sample API calls inside the docs
  • 47
    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
  • 11
    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 Read the Docs
Cons of ReadMe.io
Cons of Swagger UI
    Be the first to leave a con
    • 4
      Support is awful
    • 3
      No backup and restore capability
    • 2
      Document structure is severely restricted
    • 2
      Full of bugs
    • 2
      Important parts of the CSS are locked
    • 2
      No notifications of edits by other users
    • 1
      Supports only two documents plus a blog
    • 1
      Does not support pre-request scripts
    • 1
      Random pages display content of other pages instead
    • 1
      Review and comment functionality is hard to work with
    • 1
      Navigation in user-facing copy is spotty
    • 1
      All admins have full editing rights
    • 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 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 ReadMe.io?

    It is an easy-to-use tool to help you build out documentation! Each documentation site that you publish is a project where there is space for documentation, interactive API reference guides, a changelog, and much more.

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

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

    What tools integrate with Read the Docs?
    What tools integrate with ReadMe.io?
    What tools integrate with Swagger UI?

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

    Blog Posts

    GitHubGitSlack+30
    26
    16341
    Jun 19 2015 at 6:37AM

    ReadMe.io

    JavaScriptGitHubNode.js+25
    11
    1916
    What are some alternatives to Read the Docs, ReadMe.io, and Swagger UI?
    Confluence
    Capture the knowledge that's too often lost in email inboxes and shared network drives in Confluence instead – where it's easy to find, use, and update.
    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.
    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.
    Postman
    It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide.
    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.
    See all alternatives