platform
platform copied to clipboard
Improve proxy backend configuration page
It's not intuitive and confusing. Task is to improve this page.
Possible questions to be asked
- What is this?
- Why it is here?
- How to use it?
- What elements have to be removed?
- What data can be pre-populated?
- What titles have to be renamed?
- ...
Current version
@apinf/developers your suggestions are appreciated.
Combining API card tabs Settings and Proxy
My first choice is to combine tabs 'Settings' and 'Proxy' as one, perhaps 'Configure API'. It would be refactored such a way, that the crucial info is given at first and not so crucial later. So creating a new API card (with minimum functionality) could be done after filling only a few input fields. API owner could easily continue later. And there would be an indicator (percentage/color code,...) to indicate the completeness of API card. Indicator would be dynamic.
That page would also be replacing current page, where an API card is added.
With or without tab combination:
Break the proxy monolith at least into two parts.
Part 1
- select proxy
- proxy base path
- API base path
- API port
More guidance to explain proxy idea. Possibly even interactive guidance: picture:
- No proxy:
- app straight connection to API (address) indicated with a picture with arrows
- API connected to a proxy:
- proxy is included in picture, arrow connection from app to proxy (address) and another connection from proxy to backend API (address).
- also indication of analytics to be available, when connected to proxy is added into picture
Fields
- Names and descriptions of 'base path' fields need to be changed to more descriptive.
- user should not need to write slashes at beginning and at end of 'base path' inputs
Part 2
- the rest of fields Part 2 can be not visible on default, open the form by clicking a button.
At least some guidance and examples needed.
In issue 3236 there are also comments related on combining Settings and Proxy tabs. https://waffle.io/apinf/platform/cards/5a324e52ceae66001c5d5c4c
https://github.com/apinf/platform/issues/3236
@55 is this done in next?
@preriasusi it's not
Iceboxing this for the time being. This need more detailed planning and designing. Will be considered once Next is merged with Develop.