An overview of why documentation is important, existing approaches to it, and the one we will be using.

We'll cover the following

Do we need documentation?

The lay of the land

Do we need documentation?

We have to tackle one missing point: We have to document our API.

But isn’t the code documentation enough?

No, it is not! Leaving the issues of properly documented code aside, we will concentrate on documenting the API.

The de facto standard in our days seems to be using Swagger for this. To keep things simple, we will stick to it. Besides that, it won’t hurt to have some documentation in text form (a small file could be enough), which should explain the quirks of our API. The bigger the project, the earlier you may encounter flaws in the logic, which might not be changeable because of whatever reasons.