What is ReadMe.io?
Who uses ReadMe.io?
Why developers like ReadMe.io?
Here are some stack decisions, common use cases and reviews by companies and developers who chose ReadMe.io in their tech stack.
We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.
Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like
workspace_name so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.
Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.
This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.
Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct
Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.
Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.
We recently needed to rebuild our documentation site, currently built using Jekyll hosted on GitHub Pages. We wanted to update the content and refresh the style to make it easier to find answers.
We considered hosted services that could accept our markdown content, like ReadMe.io and Read the Docs, however both seemed expensive for essentially hosting the same platform we already had for free.
I also looked at the Gatsby Static Site generator to modernize Jekyll. I don't think this is a fit, as our documentation is relatively simple and relies heavily on Markdown. Jekyll excels at Markdown, while Gatsby seemed to struggle with it.
We're using ReadMe.io for our public API (which has been in closed Beta forever), you can see the docs here: https://docs.stackshare.io. They've got all the stuff you'd expect: custom domain support, lots of integrations, etc.
The design looks great and having the actual JSON responses on the right side panel is really nice. My favorite feature is the API Explorer which allows you to test out real API calls once you've entered a key.
We haven't really promoted the API since we're not opening up access just yet, but once we do I know ReadMe's got us covered!
- 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.
- Editor - Markdown-based drag-and-drop editor makes documentation almost fun.
- Theme Builder - Easily create a beautiful dev community that matches your brand.
- Support - Let users ask questions and request features in the support forums.
- Versioning - Maintaining old or testing beta versions of your docs is a breeze!
- Application Keys - Your users can view their application keys embedded right in the docs.