How to Add API Specific Page in Developer Portal?

, , ,
1

Hi Everyone,

I need to add examples in API details page. so i created a new nav item in API details side bar but i have no idea how to show examples page of that specific API in API details page.

2023-01-13_114120
2023-01-13_1141201892×393 8.09 KB

i screenshot i attached i created nav item named Example and want to show some details in details section on right side just like other nav items of API.

Any help would be appreciated.

2

hi @muhammad.usman22 ,

I am not able to get the exact use case.
But you can refer the APIs - webMethods.io API

In case you want to add any document you can add it on API GW documentation\ examples and then publish it to Dev Portal.

Regards
Vikash Sharma

3

Hi @Vikash_Sharma1,

Thank you for your response. I checked the documentation section but there is no option to add examples only we can upload a file, but i want to display a textual data instead of downloadable file.

2023-01-16_121550
2023-01-16_1215501916×593 24.1 KB

Although there is an option to add examples in component section but when i publish the API component section is not listed or visible on Developer portal

4

hi @muhammad.usman22,
In this case you need to add the example at each resource.
Refer below screenshot for your reference.

  1. Added the sample at resource level on API GW

image
image1190×535 26.3 KB

  1. Now publish the API to Dev portal.
  2. You should be able to see it under the resource section.

image
image1662×651 31.8 KB

Hope this helps you.

Regards
Vikash Sharma

5

Hi @Vikash_Sharma1,

Actually what i need to add is not the sample request. what i need is to add Code Samples to illustrate how to consume API in different Programming languages.

2023-01-17_141824
2023-01-17_1418241236×403 11 KB

something like this. And i need it under every resource of the API and it should be specific to that particular resource. I can create separeate pages in developer portal for every resource sample but issue is i am not able to bind those pages to specific API as the URL is dynamically generated.

something like this
/portal/apis/e8845b52-3c27-49cc-8f2c-c8c6a/resources/44fa6b90-7b9c-4d-6be36c8eb1ff/GET

6

hi @muhammad.usman22,
It can be implemented but the complexity will be on higher side.
The approach should be like create whole API details page from scratch and while designing it you can provide the sample\Code you want to have it at each resource level.
As far as I am aware of you need to create the web component for it.

Regards
Vikash Sharma

7

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.