swagger-ui icon indicating copy to clipboard operation
swagger-ui copied to clipboard

Topbar - add support for per-API auth settings

Open rellis-of-rhindleton opened this issue 2 years ago • 1 comments

Desired capability

When the Swagger UI configuration includes a urls property the top bar is enabled, so the user can switch between APIs. This has proven quite convenient, but the topbar apparently strips away any auth configuration you might have applied.

I would like to be able to include initial auth settings in the list of APIs:

{
    name: 'API Name',
    url: 'https:// ...',
    auth: {
        usePkceWithAuthorizationCodeGrant: true,
        clientId: 'string',
        scopes: 'string string',
        // ... other initial auth settings
    }
},

...and have those (re)applied when the API selection changes.

Explanation

Certain auth settings can only be set in the UI. The usePkceWithAuthorizationCodeGrant flag is a good example. Okta requires the use of PKCE when using Authorization Code flow. This means the topbar plugin is incompatible with Okta + auth code flow.

I'm not experienced enough with React/Redux to follow all of the code, but it looks like this occurs in src/plugins/topbar/topbar.jsx:

  flushAuthData() {
    const { persistAuthorization } = this.props.getConfigs()
    if (persistAuthorization)
    {
      return
    }
    this.props.authActions.restoreAuthorization({
      authorized: {}
    })
  }

  loadSpec = (url) => {
    this.flushAuthData()
    this.props.specActions.updateUrl(url)
    this.props.specActions.download(url)
  }

Workaround

If the settings can't be included in the API list, then I can wire up my own selection box instead of using the plugin. But I would need to know what methods to call on the instance to reset everything properly. Is it sufficient to just call SwaggerUIBundle and initOAuth methods again? (If someone clears this up I'll be happy to submit a PR for the docs on this.)

rellis-of-rhindleton avatar May 08 '23 14:05 rellis-of-rhindleton

Unfortunate that this has not yet been picked up!

col-panic avatar Jun 03 '25 07:06 col-panic