Maturity Report, API Specification, and Smart Recommendations

screen with maturity report API specification and Smart Recommendations

In this screen (see how to access it) you can:

Click on the links above for details on each functionality or watch the video below for an overview:

How to access the screen

To access the screen that displays the maturity report, specification, and Smart Recommendations, follow the steps below:

Access the Discovery screen by clicking it on the left side menu.
Locate the API you want to analyze and click on the icon.
In the GENERAL DATA tab, in the top right corner of the screen, click Latest Revision.
- In this case, you will see the maturity report and specification for the latest revision.
- Alternatively, below, in the DETAILS tab, click on the icon in the corresponding revision row. The icon appears in both viewing modes (Environments or Revisions).

In the Environments mode, the icon visualize

icon will be disabled when there is no API revision deployed in the environment.

The information is presented in two tabs: QUALITY ANALYSIS and SPECIFICATION.

maturity report header

The maturity score is calculated based on a set of criteria, or rules, that evaluate the API’s maturity level.

It follows a formula that assigns weights to each rule, applying penalties to the score when the criteria determined by the rules are not met.

The result is displayed on a percentage scale, along with a concept that classifies the API’s compliance level with the established rules.

These rules, along with their descriptions and weights in relation to the score calculation, are displayed in the QUALITY ANALYSIS tab.

Next to the score, you will find:

the API revision for which the report was generated,
the environments where the API is deployed, and
the button to request AI-generated application examples based on the recommendations. These examples will be available for download (Smart Recommendations).

To understand your API’s score, click the QUALITY ANALYSIS tab.

In this tab, you will find a list of rules that make up the score.

See the description of each rule, the weight it has on the score calculation, and the violations found.

Each rule is displayed in a table that contains the following columns:

RULE ID: rule code.
DESCRIPTION: rule description, with information about its objective and foundation. Contains the context and field fields.
- WEIGHT ON SCORE: percentage that the field represents in the total maturity score;
- SEVERITY OF VIOLATIONS: severity level of the violation found (None, Low, Medium, or High) and the penalized percentage.
- VIOLATIONS: by clicking on , a modal with the list of violated rules is displayed. The icon is disabled when there are no violations. For each recommendation, a colored icon indicates its severity level.

To view only the violated rules, enable the View only violated rules toggle button.

Access the SPECIFICATION tab to view the API specification (Swagger), along with its respective endpoints.

Specification tab

Thanks for your feedback!

EDIT