swagger-ui
swagger-ui copied to clipboard
Separating "Server Response" from "Responses" always takes mental effort.
I love Swagger UI. And this is a minor UI flow issue that I thought I would raise just incase others agree and it can get support.
When I use the "Try it out" button and run the operation, I always have to take a bit of mental effort to separate the actual response, from the list of potential responses.
This is (at least in part) because the Text "Server Response" and "Responses" is smaller than the headers ("Code" and "Details") for each section:
I think that increasing the size of "Server Response" and "Responses" would help. But I also think that changing "Responses" to "Potential Responses" would help clarify that they are not actual responses from the server.
Last I think that using some other visual separation between the request information and "Server Response" and also between "Server Response" and "Responses" would be helpful. A line or some other break in the UI flow.
The goal is to allow me to flow right to the Server Response without having to work mentally to track where that value is.
Suggestion
- Improve the size of the "Server Response" and "Responses" titles
- Rename "Responses" to "Possible Responses"
- Put the whole "Possible Responses" section in a sub-panel with light grey background color
Works better if all three are done together.
Mockup
Please please please can we have this. It's such a small change but it would make a huge difference.
This is something that bothers me a lot, would be great to have this prioritized.
Just started using swagger and I got highly confused by this. Terrible UI.
When I started using Swagger I thought for a long time that I had no any problems with server thanks to the "best" UI. Please, fix it.
Please fix this 🙏