Merge pull request #800 from natrem/support-oauth2-scopes

support oauth2 pre-selected scopes

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/SwaggerUiOAuthProperties.java

@@ -21,13 +21,15 @@
 package org.springdoc.core;
 
 
+import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.util.CollectionUtils;
 
 import static org.springdoc.core.Constants.SPRINGDOC_SWAGGER_UI_ENABLED;
 
@@ -83,6 +85,11 @@ public class SwaggerUiOAuthProperties {
 	 */
 	private Boolean usePkceWithAuthorizationCodeGrant;
 
+	/**
+	 * The Scopes selected by default upon authentication.
+	 */
+	private List<String> scopes;
+
 	/**
 	 * Gets config parameters.
 	 *
@@ -95,6 +102,9 @@ public Map<String, Object> getConfigParameters() {
 		SpringDocPropertiesUtils.put("realm", realm, params);
 		SpringDocPropertiesUtils.put("scopeSeparator", scopeSeparator, params);
 		SpringDocPropertiesUtils.put("appName", appName, params);
+		if (!CollectionUtils.isEmpty(scopes)) {
+			SpringDocPropertiesUtils.put("scopes", String.join(" ", scopes), params);
+		}
 		SpringDocPropertiesUtils.put("useBasicAuthenticationWithAccessCodeGrant", useBasicAuthenticationWithAccessCodeGrant, params);
 		SpringDocPropertiesUtils.put("usePkceWithAuthorizationCodeGrant", usePkceWithAuthorizationCodeGrant, params);
 		SpringDocPropertiesUtils.put("additionalQueryStringParams", additionalQueryStringParams, params);
@@ -244,4 +254,22 @@ public Boolean getUsePkceWithAuthorizationCodeGrant() {
 	public void setUsePkceWithAuthorizationCodeGrant(Boolean usePkceWithAuthorizationCodeGrant) {
 		this.usePkceWithAuthorizationCodeGrant = usePkceWithAuthorizationCodeGrant;
 	}
+
+	/**
+	 * Get the pre-selected scopes during authentication.
+	 *
+	 * @return the pre-selected scopes during authentication
+	 */
+	public List<String> getScopes() {
+		return scopes;
+	}
+
+	/**
+	 * Sets the pre-selected scopes during authentication.
+	 *
+	 * @param scopes the pre-selected scopes during authentication
+	 */
+	public void setScopes(List<String> scopes) {
+		this.scopes = scopes;
+	}
 }

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app7/SpringDocApp7Test.java

@@ -32,7 +32,8 @@
 
 @TestPropertySource(properties = { "springdoc.swagger-ui.oauth.clientId=myClientId",
 		"springdoc.swagger-ui.oauth.additionalQueryStringParams.test1=test1",
-		"springdoc.swagger-ui.oauth.additionalQueryStringParams.test2=test2" })
+		"springdoc.swagger-ui.oauth.additionalQueryStringParams.test2=test2",
+		"springdoc.swagger-ui.oauth.scopes=scope1,scope2" })
 public class SpringDocApp7Test extends AbstractSpringDocTest {
 
 	@Test

springdoc-openapi-ui/src/test/resources/results/app7

@@ -55,7 +55,7 @@
 
       window.ui = ui
 ui.initOAuth(
-{"additionalQueryStringParams":{"test1":"test1","test2":"test2"},"clientId":"myClientId"})
+{"additionalQueryStringParams":{"test1":"test1","test2":"test2"},"clientId":"myClientId","scopes":"scope1 scope2"})
     }
   </script>
   </body>

springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocApp5Test.java

@@ -28,7 +28,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-@TestPropertySource(properties = "springdoc.swagger-ui.oauth.clientId=myClientId")
+@TestPropertySource(properties = {"springdoc.swagger-ui.oauth.clientId=myClientId", "springdoc.swagger-ui.oauth.scopes=scope1,scope2"})
 public class SpringDocApp5Test extends AbstractSpringDocTest {
 
 	@Test

springdoc-openapi-webflux-ui/src/test/resources/results/index5

@@ -55,7 +55,7 @@
 
       window.ui = ui
 ui.initOAuth(
-{"clientId":"myClientId"})
+{"clientId":"myClientId","scopes":"scope1 scope2"})
     }
   </script>
   </body>