Enhance API Tile Information for Marketplace Relevance

[dulithsenanayake]

Problem

The current state of the API tile information lacks crucial business details necessary from a marketplace perspective. In order to improve the user experience and facilitate decision-making, it's essential that the API tile information provides relevant business insights.

Solution

To improve the API tile information's relevance to the marketplace point of view, the APIInfo structure should be extended to accommodate optional properties like business information and external APIs. This extension will allow API providers to supply the essential business context and references to related APIs, making the tile information more informative and valuable to potential users.

Affected Component

APIM

Version

No response

Implementation

No response

Related Issues

No response

Suggested Labels

No response

[dulithsenanayake]

Update

I have completed the initial UI design for the new API tiles. Currently, I'm working on the backend implementation for the REST API modification.

[nandika]

Test for performance impact if any after the implementation is completed

[dulithsenanayake]

Update

I have completed the UI enhancements for the new API tiles and the corresponding REST API modifications to the publisher portal. Currently, I'm working on the task of making it to be configurable. After completing this implementation, will add this to the dev portal.

[dulithsenanayake]

Update

Completed the configuring part by integrating it into the settings API, as discussed during the last sync-up. With this implementation, users are able to configure the business properties that need to be visible in the API tile through a global config.

Remaining Tasks

Adding this implementation to the dev portal.
Doing performance testing.

[dulithsenanayake]

Update

Completed the implementation of the dev portal and conducted performance tests. Please find the below screenshots for the sample publisher portal and dev portal landing page UI with API tile enhancement.

Remaining Tasks

Need to finalize the code with a code review.

[dulithsenanayake]

Hi all,

The design document for the feature can be found here[1].

[1] https://docs.google.com/document/d/187z3HkyDiByosUA55COzGBP4WX_prgnTDRgobPsSgqM/edit?usp=sharing

[dulithsenanayake]

Hi all,

The performance test results for the feature can be found here[1].

[1] https://docs.google.com/spreadsheets/d/1koUsHVeNbaXYBN-S-Uk5pnqB_pEGUK9HzCsYa7eQoj0/edit#gid=0

[dulithsenanayake]

Update

We conducted a feature code review last week, and during the review, some suggested changes were discussed. I am currently working on implementing the suggested changes.

Additional Facts

Based on the performance test results, it is recommended to proceed with the UI approach, as the backend approach results in longer response times.

While adding the feature for API products, it was noticed that monetization is not functioning correctly for API products. Please find the relevant Git issue[1].

In the email thread, there were requests to include additional details with this feature. The requests are as follows:

• Since we are adding the 'Third Party API' label in the API tile, there is a request to include details about its origin in the API Tile.

• Additionally, there is a request to add an optional empty key-value pair to accommodate any new requirements from specific customers in the future.

[1] #2176

[dulithsenanayake]

Update

Opened the carbon-apimgt PR[1] & apim-apps PR[2] to this feature. Feature details are added in the PRs with screenshots.

Please note that we haven't introduced a new configuration for the 'display' property of external APIs, as this label is already displayed in the API tile of the publisher portal when an API is marked as a Third-Party API. Therefore, we have added the same behaviour to the dev portal as well.

Below are screenshots of the new API tile for reference.

Publisher Portal

Dev Portal

Here we have added a popover to display the email of the business owner & technical owner. But we are not going to add more details here by taking the performance impact into consideration.

With Popover

• [1] [Feature] Api tile enhancement carbon-apimgt#12161
• [2] [Feature] Api tile enhancement apim-apps#501

[dulithsenanayake]

Hi all,

Please find the Doc PR[1] for this feature.

[1] wso2/docs-apim#7385

Thanks!
Dulith

[dulithsenanayake]

Hi all,

Closing this since feature changes and document changes have been completed. Please find the attached PRs [1], [2], [3] & [4].

[1] wso2/carbon-apimgt#12161
[2] wso2/apim-apps#501
[3] wso2/apim-apps#508
[4] wso2/docs-apim#7385

Thanks!
Dulith