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

Apiary

228
323
+ 1
109
Read the Docs

69
281
+ 1
22
Add tool

Apiary vs Read the Docs: What are the differences?

Developers describe Apiary as "Integrated API documentation, prototyping and testing". 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. On the other hand, Read the Docs is detailed as "Create, host, and browse documentation". Read the Docs 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. We support webhooks so your docs get built when you commit code. There's also support for versioning so you can build docs from tags and branches of your code in your repository.

Apiary and Read the Docs belong to "Documentation as a Service & Tools" category of the tech stack.

Some of the features offered by Apiary are:

  • Documentation- Organized around resources, code samples with syntax highlight, easy to explore.
  • Inspector- Users can make API calls through apiary.io, we show them how they differ from documentation.
  • Community- Opensource your API documentation on GitHub. The right channel between developers on both side of the API.

On the other hand, Read the Docs provides the following key features:

  • Github and Bitbucket Integration
  • Auto-updating
  • Internationalization

"Easy to use" is the primary reason why developers consider Apiary over the competitors, whereas "GitHub integration" was stated as the key factor in picking Read the Docs.

Read the Docs is an open source tool with 5.24K GitHub stars and 2.87K GitHub forks. Here's a link to Read the Docs's open source repository on GitHub.

Sellsuki, TestLegends, and Frank and Oak are some of the popular companies that use Apiary, whereas Read the Docs is used by StratEx, Hilenium, and Scrapinghub. Apiary has a broader approval, being mentioned in 43 company stacks & 19 developers stacks; compared to Read the Docs, which is listed in 9 company stacks and 4 developer stacks.

Advice on Apiary and Read the Docs
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 · 353.5K 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
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

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
Get Advice from developers at your company using StackShare Enterprise. Sign up for StackShare Enterprise.
Learn More
Pros of Apiary
Pros of Read the Docs
  • 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

Sign up to add or upvote prosMake 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.

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

What companies use Apiary?
What companies use Read the Docs?
See which teams inside your own company are using Apiary or Read the Docs.
Sign up for StackShare EnterpriseLearn More

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?

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

What are some alternatives to Apiary and Read the Docs?
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.
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.
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
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