Ask a Question

Swagger UI's layout could be better

mathieuber
New Member

Swagger UI's layout could be better

(Note: This is an opinion post -- nothing more than a statement. It's not a call for advice)

 

Swagger UI's layout could be much, much better.

It's extremely wide, despite most users using it on computers (which already have a wide screen).

It means that it's a lot of scrolling up and down, while most of the lateral space is wasted.

 

HOW IT LOOKS: 

 

CONTROLLER 1

   

GET /endpoint1     V
parametersTry it out

                                                         

ExecuteClear

   

Responses

codeDetails
200

...

..............................................................

.................................................

.................

   

POST/endpoint2V
parametersTry it out

                                                         

ExecuteClear

   

Responses

codeDetails
200

...

..............................................................

.................................................

.................

 

   

GET /endpoint3     V
parametersTry it out

                                                         

ExecuteClear

   

Responses

codeDetails
200

...

..............................................................

.................................................

.................

 

 

CONTROLLER 2

   

GET /endpoint1     V
parametersTry it out

                                                         

ExecuteClear

   

Responses

codeDetails
200

...

..............................................................

.................................................

.................

 

 

 

 

HOW IT COULD LOOK

 

Clickable list of all controllers:

CONTROLLER 1

  GET /endpoint1

  POST /endpoint2

  GET /endpoint3

 

CONTROLLER 2

   GET /endpoint1

Details of currently selected controller:

GET /endpoint 1

parameters : 

...

.........

...

ExecuteClear
 

 

 Responses : 

CodeDetails
200

.....

...........................

..........

.....................................

................

..............................

.................

................

 

 

By the way I know that SwaggerUI is customizable.

I'm not asking how to customize, I'm just saying that the basic layout could do better.

 

1 REPLY 1
ponelat
Staff

Thanks @mathieuber , it's definitely worth considering how to improve the layout. The team have been looking at different ways to approach it and a three-column layout was one of them.

 

I'll see if I can share some screenshots. I appreciate your illustration of what it could look like 🙂

cancel
Showing results for 
Search instead for 
Did you mean: