Enhance swagger-ui access

Describe the bug

• Swagger UI cannot load the API description after start. It only works after explicitly requesting ${apiDocs.path}/swagger-config

To Reproduce Steps to reproduce the behavior:

1. Configure springdoc as follows

  apiDocs:
    path: /api-docs/v3
    groups:
      enabled: true
  group-configs:
    - group: basic
      paths-to-match: /v2/**,
    ...

1. Start the Spring Boot application

2. Open swagger-ui/index.html?configUrl=/api-docs/v3/swagger-config

Swagger UI cannot find the API definition. The source of index.html contains:

...
<script>
    window.onload = function() {
      // Begin Swagger UI call region
      const ui = SwaggerUIBundle({
        url: "",
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: "StandaloneLayout"
      });
      // End Swagger UI call region

      window.ui = ui;
    };
  </script>

1. Open /api-docs/v3/swagger-config

2. Open swagger-ui/index.html?configUrl=/api-docs/v3/swagger-config again

Swagger UI can now find the API definition. The source of index.html contains:

    <script>
    window.onload = function() {
      // Begin Swagger UI call region
      const ui = SwaggerUIBundle({
        url: "",
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: "StandaloneLayout" ,

  "oauth2RedirectUrl" : "http://localhost:8080/swagger-ui/oauth2-redirect.html",
  "urls" : [ {
    "url" : "<redacted>",
    "name" : "<redacted>"
  } ]

      });
      // End Swagger UI call region

      window.ui = ui;
    };
  </script>

• What version of spring-boot you are using? --> 2.6.1
• What modules and versions of springdoc-openapi are you using? --> 1.6.0
• What is the actual and the expected result using OpenAPI Description (yml or json)? --> Swagger UI should always work
• Provide with a sample code (HelloController) or Test that reproduces the problem --> not related to a particular controller

Expected behavior

Swagger UI should always work

[bnasslahsen]

@waschmittel,

You are using the wrong url to request the swagger-ui. Since v1.6.0, query params are disabled by default. You can read the CHANGELOG for more details. If you want the legacy mode, you can still enable it using springdoc.swagger-ui.queryConfigEnabled=true

Use the default url as described in the documentation: http://serverName:applicationPort/swagger-ui.html or instead of swagger-ui.html the value of springdoc.swagger-ui.path

[not3baddad]

@abrudin @bnasslahsen Just wanted to thank you both for this enhancement. I’m pretty new to Java and was facing the same scenario and had no idea what was causing it or how it might have been resolved.