swagger-ui icon indicating copy to clipboard operation
swagger-ui copied to clipboard

Separating "Server Response" from "Responses" always takes mental effort.

Open Vaccano opened this issue 4 years ago • 6 comments

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:

SwaggerUIResponses

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.

Vaccano avatar Oct 22 '20 00:10 Vaccano

Suggestion

  1. Improve the size of the "Server Response" and "Responses" titles
  2. Rename "Responses" to "Possible Responses"
  3. Put the whole "Possible Responses" section in a sub-panel with light grey background color

Works better if all three are done together.

Mockup

swagger-ui-issue-6548-suggestion-1

yscialom avatar Oct 29 '20 07:10 yscialom

Please please please can we have this. It's such a small change but it would make a huge difference.

Lorless avatar May 06 '22 12:05 Lorless

This is something that bothers me a lot, would be great to have this prioritized.

jonatancompiani avatar Aug 19 '22 12:08 jonatancompiani

Just started using swagger and I got highly confused by this. Terrible UI.

Sixl-Daniel avatar Apr 13 '23 12:04 Sixl-Daniel

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.

vvamu avatar Jul 01 '23 14:07 vvamu

Please fix this 🙏

kpodkalicki avatar Jun 27 '24 09:06 kpodkalicki