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

Apiary

236
325
+ 1
109
Read the Docs

70
289
+ 1
22
ReadMe.io

119
365
+ 1
69
Advice on Apiary, Read the Docs, and ReadMe.io
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 · 395.4K 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 Apiary
Pros of Read the Docs
Pros of ReadMe.io
  • 29
    Easy to use
  • 19
    Free to use
  • 12
    Traffic inspector
  • 11
    Free
  • 10
    Collaboration
  • 7
    Mock API
  • 4
    Dashboard
  • 3
    Customization
  • 2
    30 Days Trial
  • 2
    Access Control
  • 2
    Documentation
  • 2
    Validate API Documentation
  • 1
    API explorer
  • 1
    Clean syntax
  • 1
    Provisioning
  • 1
    Shared API blueprint templates
  • 1
    Github integration helps with collaboration
  • 1
    Code auto-generation
  • 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

Sign up to add or upvote prosMake informed product decisions

Cons of Apiary
Cons of Read the Docs
Cons of ReadMe.io
    Be the first to leave a con
      Be the first to leave a con
      • 4
        Support is awful
      • 3
        No backup and restore capability
      • 2
        Important parts of the CSS are locked
      • 2
        Document structure is severely restricted
      • 2
        Full of bugs
      • 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

      Sign up to add or upvote consMake informed product decisions

      What is 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.

      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.

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

      What companies use Apiary?
      What companies use Read the Docs?
      What companies use ReadMe.io?

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

      What tools integrate with Apiary?
      What tools integrate with Read the Docs?
      What tools integrate with ReadMe.io?

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

      Blog Posts

      GitGitHubSlack+30
      27
      18698
      Jun 19 2015 at 6:37AM

      ReadMe.io

      JavaScriptGitHubNode.js+25
      12
      2471
      What are some alternatives to Apiary, Read the Docs, and ReadMe.io?
      Apigee
      API management, design, analytics, and security are at the heart of modern digital architecture. The Apigee intelligent API platform is a complete solution for moving business to the digital world.
      Postman
      It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide.
      Stack Overflow
      Stack Overflow is a question and answer site for professional and enthusiast programmers. It's built and run by you as part of the Stack Exchange network of Q&A sites. With your help, we're working together to build a library of detailed answers to every question about programming.
      Google Maps
      Create rich applications and stunning visualisations of your data, leveraging the comprehensiveness, accuracy, and usability of Google Maps and a modern web platform that scales as you grow.
      Elasticsearch
      Elasticsearch is a distributed, RESTful search and analytics engine capable of storing data and searching it in near real time. Elasticsearch, Kibana, Beats and Logstash are the Elastic Stack (sometimes called the ELK Stack).
      See all alternatives