petstore URL not disabled in SpringDoc OpenAPi

Question

I am using SpringDoc 1.4.3 for swagger.
I have added the below configuration to disabled the petstore URLs in application.yml

Configuration

springdoc:
  swagger-ui:
    disable-swagger-default-url: true
    tags-sorter: alpha
    operations-sorter: alpha
    doc-expansion: none

but when I hit the https://petstore.swagger.io/v2/swagger.json in explore text box, it is still showing me the petsore URLs as shown in the below image.

Swagger Image

score 28 · Accepted Answer · answered Aug 02 '20 at 12:57

28

Already tested and validated thanks to the following feature support:

https://github.com/springdoc/springdoc-openapi/issues/714

Just use, the following property:

springdoc.swagger-ui.disable-swagger-default-url=true

answered Aug 02 '20 at 12:57

yet that is working, but if we add the URL `https://petstore.swagger.io/v2/swagger.json ` explicitly in explore textbox then it is still showing. as shown in the attached screen shot – SSK Aug 03 '20 at 06:15
1

You should block it in your firewall rules, if you want to block Access. Petstore URL is like any other urls. – Aug 24 '20 at 12:21
add that property for your default API docs URL: springdoc.swagger-ui.url=/v1/api-docs – Dmitri Algazin Oct 10 '22 at 11:12

score 6 · Answer 2 · answered Dec 19 '21 at 11:29

6

For those if the suggested property setting did not work, clear the browser cache and reload the URL. The property setting DOES WORK. Wasted 2 hours to figure it out.

springdoc:
  swagger-ui:
    disable-swagger-default-url: true

answered Dec 19 '21 at 11:29

mAsK

189
3
9

Greg · Answer 3 · 2023-04-29T22:49:21.793

In my case, I had an incorrectly-defined servlet filter - I was missing a 'return;' statement. This caused the filter chain to not be processed properly, and some of the Swagger requests got borked.

Check to see if you have the following condition:

@Component
public class MyFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        if (some condition) {
            chain.doFilter(request, response);

            return;    /**** Don't forget this line! ****/
        }

        ... more logic ...

        chain.doFilter(request, response);
    }
}

Thank you! That's exactly the cause that I had. – Sergey Karpushin Apr 24 '23 at 09:53 — Sergey Karpushin, Apr 24 '23 at 09:53

score -1 · Answer 4 · answered Jul 28 '21 at 16:42

-1

The only way I got around this was by adding a SwaggerConfig page [tutorial here] and changing to OAS_3 and saving, and then you can either change it to something else after.

return new Docket(DocumentationType.OAS_30)

It just seems like Swagger is keeping a cache or something, but saving a configured OAS_3 seems to let Swagger know to stop using the default.

answered Jul 28 '21 at 16:42

turniprincess

49
3

1

The question is about Springdoc, and this answer about Springfox. – Sander Verhagen Oct 04 '21 at 09:50

score -5 · Answer 5 · answered Oct 21 '21 at 05:49

-5

Set below property, this will disable Swagger OpenApi 3 UI module

springdoc.api-docs.enabled=false

answered Oct 21 '21 at 05:49

chiragh-rey

103
1
3

1

It disables the whole swagger ui – Rabin Mallilck Apr 06 '22 at 14:48

petstore URL not disabled in SpringDoc OpenAPi

5 Answers5

Linked