This is the third part of the API documentation series. In the last part we explored the first solution using API Blueprint a bit, and in this article, we are covering RAML.
This is the second part of the API documentation series. In the first, we covered for whom the documentation is written, what it should contain and the three different types of writing it. Starting with this part, we dive a bit deeper into the latter and explore some standard formats and ways of writing.
Documenting your API is extremely important. Without documentation, nobody, not your product owner, devs or your customers know what your API does and how to use it. In this article series, we will take a look at common ways of documenting, their advantages and disadvantages and explore different solutions.
APIs have gone a long way from a purely technical thing to now being a core business. Many businesses depend so much on their APIs that they would go out of business when the APIs fail. But whos responsible for building and maintaining?
Or when is a REST API a REST API? That is the question. And there is no easy answer. Let’s take a closer look.