Swagger UI - How can I expand all the operations by default?

Question

All the operations appear collapsed when I open it and I want it to be expanded by default.

Is there any property I need to change to achieve it?

This is my swagger Bean:

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket restApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .paths(regex("/api/.*"))
                .build()
                .directModelSubstitute(XMLGregorianCalendar.class, Date.class)
                .apiInfo(apiInfo())                
                .useDefaultResponseMessages(false);
    }
}

score 50 · Accepted Answer · edited Aug 31 '17 at 11:26

50

I believe you can set the docExpansion:"full" when creating swagger-ui.

See https://github.com/swagger-api/swagger-ui#parameters for details.

docExpansion: Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). The default is 'list'.

edited Aug 31 '17 at 11:26

Xin Meng

1,982
3
20
32

answered Nov 28 '15 at 07:38

fehguy

6,724
25
23

1

Updated doc link: https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#display – dpmott Aug 21 '19 at 20:25

Rosdi Kasim · Answer 2 · 2020-04-16T09:20:27.363

25

I just found out I actually can pass the parameter to the swagger url like so:

http://...../swagger/index.html?docExpansion=none

docExpansion : "none" - hide everything.

docExpansion : "list"- expand/List all the operations only.

docExpansion : "full" - expand everything (full expand as the name says).

edited Apr 16 '20 at 09:20

answered Mar 05 '19 at 08:59

Rosdi Kasim

24,267
23
130
154

1

it's helpful to change this at query time. – liang Apr 16 '20 at 05:38

score 9 · Answer 3 · answered Oct 11 '18 at 13:39

Here is the answer with Springfox which is what you seem to use :

  @Bean
  UiConfiguration uiConfig() {
    return UiConfigurationBuilder.builder()
        .docExpansion(DocExpansion.LIST) // or DocExpansion.NONE or DocExpansion.FULL
        .build();
  }

source : http://springfox.github.io/springfox/docs/current/#springfox-swagger2-with-spring-mvc-and-spring-boot

score 4 · Answer 4 · answered Jun 08 '22 at 14:02

For .NET Core/Framework using C#,

You can simply configure the Document Expansion/UnExpansion as given below

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Fire Cloud Client Authentication Service API V1.0");
        c.DocExpansion(DocExpansion.None);//This will not expand all the API's.

    });
}

score 3 · Answer 5 · answered May 24 '18 at 05:58

I did it by adding the required changes in the swaggerUi. You need to change it as per your requirement as below;

docExpansion : "none" - It'll Hide everything.
docExpansion : "list"- It'll expand/List all the operations only.
docExpansion : "full" - It'll expand everything(Full expand as the name says).

score 2 · Answer 6 · answered Jun 27 '17 at 08:14

private static final String DOC_EXPANSION = "list"; //none, full

    @Bean
    public UiConfiguration uiConfig() {
        return new UiConfiguration(
                null, DOC_EXPANSION, "alpha", "schema", UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS, false, true, null
        );
    }

score 1 · Answer 7 · answered Feb 09 '23 at 08:33

1

in case if you use springdoc, this property can be helpful.

springdoc.swagger-ui.docExpansion=full

answered Feb 09 '23 at 08:33

menakshisundaram

153
1
5

Swagger UI - How can I expand all the operations by default?

7 Answers7