Swagger-ui: Detecting default server url

[domenkozar]

Is your feature request related to a problem?

We have different server urls: localhost, review apps, staging and production. Everytime one uses
swagger ui, they have to pick correct server first. Currently default server url is the first configured, this can be confusing since swagger is sending request somewhere else, getting one to think something is wrong with the current url.

Describe the solution you'd like

It would be intuitive if server url was picked to match the browser url from where
swagger ui is served (if it does match).

[bestmike007]

What about maintaining a list of links to different environments, e.g.

• Production: http://petstore.swagger.io/?url=http://www.example.com/swagger-api-docs.yaml
• Staging: http://petstore.swagger.io/?url=http://staging.example.com/swagger-api-docs.yaml
• Dev: http://petstore.swagger.io/?url=http://dev.example.com/swagger-api-docs.yaml

[domenkozar]

It's hard to implement that, since review apps post different url for each PR, changing heroku github bot to append the correct url is probably not possible - I doubt it allows configuration.

What's prevent swagger ui to do the right thing? The algorithm would be:

1) go over list of servers, top to bottom
2) for each item, check if it matches prefix of browser url
3) if they match, pick as default and stop
4) if none of the urls in list matches, pick the first server as default

[bestmike007]

Are you using a shared instance like http://swagger-ui.your-project.com? If you do so, you can customize it.

If I'm getting this right, you can write your own logic to place these lines: https://github.com/swagger-api/swagger-ui/blob/v3.17.4/dist/index.html#L42-L54.

[domenkozar]

I'm not following what configuration exactly should change this. I have:

const ui = SwaggerUIBundle({
  url: "https://custom-app-pr-61.herokuapp.com/api/v1/openapi.yaml",
  dom_id: '#swagger-ui',
  deepLinking: true,
  presets: [
   SwaggerUIBundle.presets.apis,
   SwaggerUIStandalonePreset
  ],
  plugins: [
   SwaggerUIBundle.plugins.DownloadUrl
  ],
  layout: "StandaloneLayout"
})

But regardless of url, it still picks http://localhost as default.

[bestmike007]

So you have multiple servers for several environment in the same api document?

In such case, yes, the first server will be selected by default: https://github.com/swagger-api/swagger-ui/blob/v3.17.4/src/core/plugins/oas3/components/servers.jsx#L25

You could write a wrapComponent plugin to override this behavior. Refs:

• https://github.com/swagger-api/swagger-ui/blob/v3.17.4/docs/customization/plugin-api.md#wrap-components
• https://github.com/swagger-api/swagger-ui/blob/v3.17.4/docs/usage/configuration.md#plugin-system

Or alternatively, wrap the selector: https://github.com/swagger-api/swagger-ui/blob/v3.17.4/src/core/plugins/oas3/selectors.js#L20

[silverwind]

Couldn't wrap my head around this wrapping business, so I have a rather dirty hack in place to preselect a certain server from the list by programmatically triggering the select box.

Would appreciate a option to pre-select a server via maybe by the URL or a user-defined function that receives the servers array and returns a index to select.