Need advice about which tool to choose?Ask the StackShare community!
Apiary vs ReadMe.io: What are the differences?
What is Apiary? 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.
What is ReadMe.io? Beautiful documentation made easy. Collaborative Developer Hubs.
Apiary and ReadMe.io can be primarily classified as "Documentation as a Service &" tools.
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, ReadMe.io provides the following key features:
- Collaboration - Crowdsource your docs! Users can keep docs current by suggesting changes.
- API Explorer - Let users play with your API right inside the documentation.
- GitHub Sync - Keep auto-generated reference docs synced with your actual code.
"Easy to use" is the primary reason why developers consider Apiary over the competitors, whereas "Great UI" was stated as the key factor in picking ReadMe.io.
Sellsuki, TestLegends, and Frank and Oak are some of the popular companies that use Apiary, whereas ReadMe.io is used by UNION, ReadMe.io, and Codacy. Apiary has a broader approval, being mentioned in 43 company stacks & 19 developers stacks; compared to ReadMe.io, which is listed in 33 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 ReadMe.io
- Great UI18
- Easy15
- Customizable10
- Cute mascot10
- Looks great and is fun to use8
- It's friggin awesome5
- Make sample API calls inside the docs3
Sign up to add or upvote prosMake informed product decisions
Cons of Apiary
Cons of ReadMe.io
- Support is awful4
- No backup and restore capability3
- Important parts of the CSS are locked2
- Document structure is severely restricted2
- Full of bugs2
- No notifications of edits by other users2
- Supports only two documents plus a blog1
- Does not support pre-request scripts1
- Random pages display content of other pages instead1
- Review and comment functionality is hard to work with1
- Navigation in user-facing copy is spotty1
- All admins have full editing rights1