Document the `ApiDocumentation` class and its functionality

[LeNelSoN]

Description:

The goal of this task is to write documentation for the ApiDocumentation class and its mechanism for generating internal API documentation. The ApiDocumentation class is responsible for structuring API endpoint documentation for internal purposes. It uses a builder to simplify the creation and management of various pieces of information related to each endpoint (such as title, description, request format, request body template, etc.).

Quests:

1. Explain the role of the ApiDocumentation class:

• Describe the purpose of this class in centralizing the API documentation within the project.
• Explain each attribute of the class (title, description, requiredHeaders, etc.).

2. Describe the functionality of the ApiDocumentationBuilder:

• Explain how the builder simplifies the creation of documentation.
• Detail how each method adds specific information to the documentation.

3. Clarify the documentation format:

• Mention that the build() method generates a Map<String, String> with the endpoint details as strings.
• Explain how request body templates are represented as strings.

4. Explain the data models:

• Describe the data types used (e.g., TemplateDTO, LinkType).

5. Add an example of usage:

• Include a simple example of how to create documentation using the ApiDocumentationBuilder.

The keeper of the repo 🏰