If you build APIs, you need to document them. After all, for your users to use your API, they need to know how to use it. A common phrase I like to use as someone who writes a lot of docs is “If it’s not documented, it does not exist” – your users can only use a feature if they can discover not only that it exists, but also how to use it.

So what is API documentation? How should you write it? What should you include? What are the best practices? In this post, I’ll answer all of these questions and more and give you some best practices for creating API documentation.

Leave a Reply

Your email address will not be published. Required fields are marked *