How to set the client_id for OAuth 2 about swagger-ui-express HOT 10 CLOSED

Just added so you should be able to define custom ouath settings like so:

var options = {
	validatorUrl : null,
	oauth: {
	 clientId: "your-client-id1",
	 clientSecret: "your-client-secret-if-required1",
	 realm: "your-realms1",
	 appName: "your-app-name1",
	 scopeSeparator: ",",
	 additionalQueryStringParams: {}
       }
};

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, false, options));

Let me know if that works and I will update the documentation. You will need to make sure to define all the oauth settings as it simply replaces the current object with the one you define.

@scottie1984
Is the "oauth" param documented anywhere? Had quite the trouble finding out how to do this and would like to help anyone in the future find this easier. You have a line in the README "For all the available options, refer to Swagger UI Configuration" but the key "oauth" does not exist there.

Thanks.

from swagger-ui-express.

This should be possible by passing a custom onComplete function into swagger-ui-express:

const options: {
      onComplete: function(swaggerApi, swaggerUi){
	   if(typeof initOAuth == "function") {
	       initOAuth({
	           clientId: "your-client-id",
	           clientSecret: "your-client-secret-if-required",
	           realm: "your-realms",
	           appName: "your-app-name",
	           scopeSeparator: ",",
	           additionalQueryStringParams: {}
	       });
	  }
          if(window.SwaggerTranslator) {
	       window.SwaggerTranslator.translate();
	  }
     }
}
	
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, false, options));

Let me know and if it doesn't work I can create a new version to allow you to pass oAuth options through.

from swagger-ui-express.

Looking at index.js, JSON.stringify is called on options, so the method is lost at that point.

from swagger-ui-express.

Apologies - my bad!

{
clientId: "your-client-id",
clientSecret: "your-client-secret-if-required",
realm: "your-realms",
appName: "your-app-name",
scopeSeparator: ",",
additionalQueryStringParams: {}
}

Would you accept being able to pass in this object to the module?

from swagger-ui-express.

Yes, that would work for me

from swagger-ui-express.

Just added so you should be able to define custom ouath settings like so:

var options = {
	validatorUrl : null,
	oauth: {
	 clientId: "your-client-id1",
	 clientSecret: "your-client-secret-if-required1",
	 realm: "your-realms1",
	 appName: "your-app-name1",
	 scopeSeparator: ",",
	 additionalQueryStringParams: {}
       }
};

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, false, options));

Let me know if that works and I will update the documentation. You will need to make sure to define all the oauth settings as it simply replaces the current object with the one you define.

from swagger-ui-express.

@scottie1984 , any updates on this issue? I also need this to provides additional query parameters.

The solution you are going to provide above is OK for us. I made a local test with your solution by adding following code into the indexTemplate:

...
  var ui = SwaggerUIBundle(swaggerOptions)

  if (customOptions.oauth) {
    ui.initOAuth(customOptions.oauth)
  }

  window.ui = ui
...

Any plan when you will provide this feature, or if I missed anything?

from swagger-ui-express.

I have merge that in - let me know if everything works ok.

from swagger-ui-express.

I have tested using the v2.0.3 npm package, it works well.

from swagger-ui-express.

Any help documenting this would be great.

from swagger-ui-express.