WhiteLabel error page while trying to access swagger-ui.html using springfox configuration

Question

I am trying to generate Swagger documentation from a springboot project using Springfox and following https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api documentation.

Initially I got the error "Full authorization is required to access the resource" since I am using OAuth2 in my application. I changed the configuration to permit all the requests ending with /swagger-ui.html.

Now I have been getting "WhiteLabel error page - This application has no explicit mapping for /error" while trying to access /swagger-ui.html on my local.

I went through various posts but none of the solutions worked for me - I am not using @webmvcconfiguration which can interfere. Can anyone help?

score 6 · Accepted Answer · answered Aug 18 '20 at 12:14

6

For Swagger 3.0, The URL is changed to

http://localhost:8080/swagger-ui/index.html

answered Aug 18 '20 at 12:14

ace

11,526
39
113
193

I have the same problem but I couldn't open it. Here is the link : https://stackoverflow.com/questions/75391306/cannot-open-swagger-2-in-spring-boot-3-app – S.N Feb 08 '23 at 20:54

score 2 · Answer 2 · answered Sep 14 '20 at 04:35

Remove the v2 dependencies from your pom.xml or comment them out.

 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>3.0.0</version>
 </dependency>

 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>3.0.0</version>
 </dependency>

Add the springfox-boot-starter

 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-boot-starter</artifactId>
     <version>3.0.0</version>
 </dependency>

Change the URL in your browser to: http://localhost:8080/swagger-ui/index.html

The general form for the URL is:

http://host/context-path/swagger-ui/index.html OR
http://host/context-path/swagger-ui/

For more info check this link that leads to the relevant documentation: https://springfox.github.io/springfox/docs/snapshot/#changes-in-swagger-ui

score 1 · Answer 3 · edited Sep 27 '20 at 21:06

This is how I solved my problem. Here is my detailed code, if someone want to look.

https://github.com/xbox2204/SpringBoot-JPA-Swagger

Now, I used 3.0.0-SNAPSHOT and a latest spring-boot starter project I created from here:

https://start.spring.io/

My pom.xml, I added following dependencies:

    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.plugin</groupId>
                    <artifactId>spring-plugin-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.plugin</groupId>
            <artifactId>spring-plugin-core</artifactId>
            <version>2.0.0.RELEASE</version>
        </dependency>

In my application.properties, I added following:

spring.resources.add-mappings=true

In my SpringBoot Main/Runner class, I added these annotations

@EnableWebMvc
@EnableSwagger2
@SpringBootApplication

My Docket returning function looked like this

@Bean
    public Docket productApi() {
        Contact contact =new Contact(
                "Vineet Mishra",
                "https://github.com/xbox2204",
                "whatwillyoudo@withmyemail.com"
        );
        ApiInfo apiInfo= new ApiInfoBuilder().title("VINEET SPRING-BOOT API")
                .description("Spring-Boot for all")
                .termsOfServiceUrl("jUST CHILL!!!")
                .contact(contact)
                .licenseUrl("something@something.com").version("1.0").build();

        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.any())
                .build();
    }

Finally, I accessed my swagger-ui from

http://localhost:8080/swagger-ui/index.html#

Image of final result

score 0 · Answer 4 · answered Dec 03 '18 at 21:50

0

The swagger-ui.html page makes a number of calls to get all the details. If you use your browser's dev tools (usually just press F12 to open) you will see failing requests in the network tab. You'll need to permit requests to

    "/v2/api-docs",
    "/swagger-resources/**",
    "/swagger-ui.html**",
    "/webjars/**"

There's some info in the springfox docs , do a find for 'security' or 'authorization'

answered Dec 03 '18 at 21:50

pcoates

2,102
1
9
20

Thanks! I also thought that it was some security issues. But it was a url issue. I was trying to hit swagger-ui.html using localhost:8080//swagger-ui.html however it is working at localhost:8080/swagger-ui.html. – adeveloper Dec 04 '18 at 17:41
how do you permit these requests??? Where do I write those lines? in eclipse? which file? application.properties??? – Gel Apr 06 '19 at 04:12
try disable all security checks, https://stackoverflow.com/a/38405624/944593 – shareef Jun 19 '20 at 13:08

WhiteLabel error page while trying to access swagger-ui.html using springfox configuration

4 Answers4