Need advice about which tool to choose?Ask the StackShare community!
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 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.
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.
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
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 Read the Docs
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
Sign up to add or upvote consMake informed product decisions
What is Apiary?
What is Read the Docs?
What is ReadMe.io?
Need advice about which tool to choose?Ask the StackShare community!
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 ReadMe.io?
Sign up to get full access to all the tool integrationsMake informed product decisions
Blog Posts
+6
+30
+25