Improve API tryout UX - Githubissues

wso2 / product-apim

Welcome to the WSO2 API Manager source code! For info on working with the WSO2 API Manager repository and contributing code, click the link below.

http://wso2.github.io/

Apache License 2.0

845 stars 785 forks source link

Improve API tryout UX #11997

Open tmkasun opened 2 years ago

tmkasun commented 2 years ago

Describe your problem(s)

Currently, we have used Swagger UI for trying out API requests in both Publisher and Developer portals, This issue is to track the improvement of API try-out UX in all places.

Swagger UI is kind of outdated and not very intuitive by design, So the suggestion here is to replace it with a better alternative or implement a better API tryout UI

Describe your solution

Available Tryout tools out there

Stoplight Elements
Redocly (Without tryout panel)

How will you implement it

tmkasun commented 2 years ago

Re: Stoplight Elements,

Did a quick test and I think we need to have this intercept request feature to use with Publisher/Devportal tryout UI

tmkasun commented 2 years ago

More on: Stoplight Elements,

Tryout: We have to either remove the Auth input section or auto-fill with generated bearer tokens, API Key, or user-provided Basic auth values
Servers selection: Have to override the selector behavior

tmkasun commented 2 years ago

hoppscotch supports testing most of the API types we have in APIM,(REST, GQL, SSE, and more)

Better if we can replace hopscotch with Swagger UI.

Seems like they don't support importing OAS definitions yet.

"Re: Integrating https://hoppscotch.io/ to"