API Security Best Practices for Cloud vs. On-Premise Environments Back in December of 2021, Twitter (or X nowadays) suffered its biggest data breach in history. One of its APIs allowed malicious actors to submit email addresses or phone numbers on the platform and get…
API Documentation Essentials: From Creation to Integration Welcome to the often chaotic realm of API documentation. A place where developers pray for solid examples instead of placeholder syntax. Technical writers try to balance technical accuracy with user-friendly language. Tech leads become masters…
Get To Know Your User for a Better API APIs are hard to use, but they don’t need to be that way. At ReadMe, we help companies to make their APIs easier to use through documentation. Most of these companies make a product and…
Why These API Docs are Better Than Yours (And What You Can Do About it) Once upon a time, API docs were written as an afterthought. Developers would build a new platform and then pour all their efforts into designing an API that would give other developers access to their…
4 Steps to Implementing Stellar Documentation As a minimalist, I’m rarely excited to purchase things, yet I can’t help but share how awesome this KeShi foam roller kit is. Interestingly, the magical part isn’t the foam roller or the massage stick…
Quick Switcher: Speed Up Your Workflow Introducing Quick Switcher, the fastest way to navigate ReadMe. How does it work? Press ⌘+K on Macs or Ctrl+K on Windows anywhere inside ReadMe to search for and jump directly to: Pages (from Guides, API…
Workflow: Collaborative Documentation with Suggested Edits Recently, we released a brand new version of our Suggested Edits feature and as we were testing it internally, it dramatically changed how we approached writing documentation. It’s allowed us to more easily collaborate on…
Why You Should Let Robots Help You Write Your API Documentation Creating clear, beautiful documentation is one of the biggest pains of being a developer. That's why autodoc tools like Rdoc are so appealing. Type a line in your terminal, and like magic, you get an…
Documenting Your API Right in Your Code With OpenAPI OpenAPI Specification (OAS), formerly known as Swagger, has become the de facto standard for documenting APIs. While building out our support for it, however, we found it was a bit tough to create, manage, and…