Need advice about which tool to choose?Ask the StackShare community!
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.
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?"
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).
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.
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.
Pros of Apiary
- Easy to use29
- Free to use19
- Traffic inspector12
- Free11
- Collaboration10
- Mock API7
- Dashboard4
- Customization3
- 30 Days Trial2
- Access Control2
- Documentation2
- Validate API Documentation2
- API explorer1
- Clean syntax1
- Provisioning1
- Shared API blueprint templates1
- Github integration helps with collaboration1
- Code auto-generation1
Pros of Read the Docs
- GitHub integration13
- Free for public repos7
- Automated Builds2