Skip to content


In order to share or gather information about API usage, standards, URL schemes, paths, parameters and more, one needs to document the API. It promotes clarity, reduces ambiguity, and enhances the developer experience, facilitating successful integration and utilization of the API. Users can do it manually; however, to save time and effectively consolidate the whole information, the Yappes API Manager allows users to do it just a few clicks away.

Reports Window

By accessing the Reports functionality, users with the platform-admin or api-product-manager role can generate a pdf document of the API.

The generated API report document includes the information in the following structure.

1. Overview

The Overview section provides a general introduction to the API, including its purpose and basic usage guidelines.

2. Paths

The Paths section outlines the available endpoints and their functionalities. Developers can find detailed information on each path, including example requests and responses.

2.1 /backend/path

This endpoint serves the purpose of [brief description].


GET /backend/path


  • HTTP 200: Successful operation

      "key": "value"

3. Definitions

The Definitions section defines the data structures used within the API. Developers can refer to this section to understand the format of request and response payloads.


The 'RESULT' object has the following structure:

  "key": {
    "type": "string"

4. Security

The Security section describes the authentication and authorization mechanisms in place for the API.

4.1 Token: yappes-auth

This API uses a token-based authentication system. Developers need to include the 'yappes-auth' token in the header of their requests.

4.2 API Keys

Two API keys, 'x-yappes-key' and 'x-yappes-subkey,' are required in the header for authentication.

5. Version Information

The Version Information section specifies the current version of the API, its standard, usage status, and the revision date.

6. Categories

This section mentions any custom tags or categories associated with the API.

7. Contact Information

In this section you can provide contact information like email address.

8. License Information

This section provides API license and respective link to view the license.

9. URI Scheme

10. External Docs

To generate a report, follow the instructions in the following article: