urls option from custom swagger-config.yaml ignored.

[pschichtel]

Q&A (please complete the following information)

• OS: Archlinux
• Browser: Firefox
• Version: 76
• Method of installation: Docker
• Swagger-UI version: 3.25.3
• Swagger/OpenAPI version: OpenAPI 3.0

Content & configuration

Swagger-UI configuration options:
I tried both yaml and json:

---
urls:
  - name: Master API
    url: specs/master.yaml
  - name: Bot API
    url: specs/bot.yaml

{
    "urls": [
        {
            "name": "Master API",
            "url": "specs/master.yaml"
        },
        {
            "name": "Bot API",
            "url": "specs/bot.yaml"
        }
    ]
}

I looked at the swagger-config.yaml from this repository for reference.

Describe the bug you're encountering

I have a micro service system with various swagger-specified APIs. My goal was to create a dedicated application, that integrates all the swagger documentation. ron in IRC suggested to use the urls option to configure multuple spec URLs to be selected. So I pulled the swaggerapi/swagger-ui:v3.25.3 image, copied my files in specified the URLS environment variable. As expected: The swagger UI shows the first URL in the list by default and allows to switch between the URLs using a selection in the header. Because we have many APIs, I then tried to use a custom swagger-config.yaml by copying it into the container and specifying CONFIG_URL=swagger-config.yaml with the contents from above.

The UI seems to load the correct swagger-config.yaml (or .json) file, but it still shows the default petstore spec, apparently ignoring the provided urls option.

To reproduce...

Steps to reproduce the behavior:

1. Copy a swagger spec to /usr/share/nginx/html/specs/ inside the swaggerapi/swagger-ui:v3.25.3 image
2. Copy a swagger-config.yaml to /usr/share/nginx/html/swagger-config.yaml with the following content:

   ---
   urls:
     - name: Spec
       url: specs/<spec file name>
   

3. Add ENV CONFIG_URL=swagger-config.yaml to the Dockerfile (or set it while running the container)
4. Open the swagger UI in the browser

Expected behavior

I'd expect to see the spec from the configured URL

[pschichtel]

env output from within the container:

BASE_URL=/docs
SWAGGER_JSON=/app/swagger.json
HOSTNAME=268ca27a3b29
SHLVL=1
PORT=8080
HOME=/root
PKG_RELEASE=1
CONFIG_URL=swagger-config.yaml
TERM=xterm
NGINX_VERSION=1.17.10
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
NJS_VERSION=0.3.9
API_KEY=**None**
PWD=/

Generated SwaggerUIBundle call:

// Begin Swagger UI call region
const ui = SwaggerUIBundle({
  url: "https://petstore.swagger.io/v2/swagger.json",
  "dom_id": "#swagger-ui",
  deepLinking: true,
  presets: [
    SwaggerUIBundle.presets.apis,
    SwaggerUIStandalonePreset
  ],
  plugins: [
    SwaggerUIBundle.plugins.DownloadUrl
  ],
  layout: "StandaloneLayout",
  configUrl: "swagger-config.yaml",
})


// End Swagger UI call region

[pschichtel]

Has there been any progress here?

[TechHoops]

Wondering if anyone has any suggestions to resolve this? Stuck with exact same issue

[tim-lai]

@pschichtel It appears that the documentation for the urls parameter for Docker is incorrect. This feature has not yet been implemented. Right now, you can only specify a single url, not an array of urls.

[tim-lai]

@pschichtel update.. looks like I was wrong with my earlier comment. Take a look at this: #6465 , where you can specify URLS in the docker-compose .env file.

[tim-lai]

Hmm, reading this again, this does look like a bug. Where it works as a querystring but not as a env variable.

[pschichtel]

this is about the option from swagger-config.yaml getting ignored, not about query or env vars.

[gueuselambix]

Hitting the same issue here.
We want to collect several API-specs in one swagger-ui. Adding them via env URLS works, but is not human readable, YAML configuration is way better for this.

[pschichtel]

I worked around this by customizing the container with a custom entrypoint, that reads the config and fills in the ENV as required.

Before that I had another look at the code and it seems to me as if the Topbar is simply rendering too early, since the config loading happens asynchronous while the rest of the initialization continues immediately, so the UI renders with defaults instead of the external config. I'd assume this could be fixed by either triggering another component render once the config has finished loading or by delaying the rendering until the config is loaded.

I don't have the time to get into the codebase and since my workaround is acceptable for us, but it would still be great to have this fixed.