Customize Servers via application.yml. Fixes #2948

bnasslahsen · bnasslahsen · commit 1637f268eff6 · 2025-03-26T14:33:15.000+01:00
diff --git a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/SpecPropertiesCustomizer.java b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/SpecPropertiesCustomizer.java
@@ -26,6 +26,7 @@
 
 package org.springdoc.core.customizers;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -144,6 +145,9 @@ private void customizeOpenApi(OpenAPI openApi, OpenAPI openApiProperties) {
 			if (!CollectionUtils.isEmpty(securityRequirementsProperties)) {
 				customizeSecurity(openApi, securityRequirementsProperties);
 			}
+			if (!CollectionUtils.isEmpty(openApiProperties.getServers())) {
+				openApi.setServers(new ArrayList<>(openApiProperties.getServers()));
+			}
 		}
 	}
 
@@ -364,5 +368,4 @@ private void resolveSet(Consumer<List> setter, Supplier<List> getter) {
 		}
 	}
 
-
 }
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/application-212.yml b/springdoc-openapi-starter-webmvc-api/src/test/resources/application-212.yml
@@ -1,5 +1,10 @@
 springdoc:
   open-api:
+    servers:
+      - url: "https://api.example.com"
+        description: "Production Server"
+      - url: "https://staging.example.com"
+        description: "Staging Server"
     info:
       title: Api info title
       description: Api info description
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/application-217.yml b/springdoc-openapi-starter-webmvc-api/src/test/resources/application-217.yml
@@ -13,6 +13,9 @@ springdoc:
           termsOfService: http://localhost:8080/
           license:
             name: Apache 2.0
+        servers:
+          - url: "https://demo.example.com"
+            description: "demo Server"
         components:
           schemas:
             PersonDTO:
@@ -34,6 +37,9 @@ springdoc:
           termsOfService: http://localhost:8080/
           license:
             name: Apache 2.0
+        servers:
+          - url: "https://user.example.com"
+            description: "user Server"
         components:
           schemas:
             PersonDTO:
@@ -42,7 +48,12 @@ springdoc:
                 name:
                   description: Description for 'name' property
                   example: Example value for 'name' property
-  open-api: 
+  open-api:
+    servers:
+      - url: "https://api.example.com"
+        description: "Production Server"
+      - url: "https://staging.example.com"
+        description: "Staging Server"
     info:
       title: Api info title
       description: Api info description
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app212-grouped.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app212-grouped.json
@@ -7,8 +7,12 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://api.example.com",
+      "description": "Production Server"
+    },
+    {
+      "url": "https://staging.example.com",
+      "description": "Staging Server"
     }
   ],
   "security": [
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app212.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app212.json
@@ -7,8 +7,12 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://api.example.com",
+      "description": "Production Server"
+    },
+    {
+      "url": "https://staging.example.com",
+      "description": "Staging Server"
     }
   ],
   "security": [
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app217-1.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app217-1.json
@@ -11,8 +11,8 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://demo.example.com",
+      "description": "demo Server"
     }
   ],
   "paths": {
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app217-2.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app217-2.json
@@ -11,8 +11,8 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://user.example.com",
+      "description": "user Server"
     }
   ],
   "paths": {
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app217.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app217.json
@@ -7,8 +7,12 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://api.example.com",
+      "description": "Production Server"
+    },
+    {
+      "url": "https://staging.example.com",
+      "description": "Staging Server"
     }
   ],
   "paths": {
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app212-grouped.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app212-grouped.json
@@ -7,8 +7,12 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://api.example.com",
+      "description": "Production Server"
+    },
+    {
+      "url": "https://staging.example.com",
+      "description": "Staging Server"
     }
   ],
   "security": [
@@ -106,14 +110,14 @@
     "schemas": {
       "PersonDTO": {
         "type": "object",
+        "description": "Description for PersonDTO component in ApiGroupName",
         "properties": {
           "name": {
             "type": "string",
             "description": "Description for 'name' property in ApiGroupName",
             "example": "Example value for 'name' property in ApiGroupName"
           }
-        },
-        "description": "Description for PersonDTO component in ApiGroupName"
+        }
       }
     },
     "securitySchemes": {
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app212.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app212.json
@@ -7,8 +7,12 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://api.example.com",
+      "description": "Production Server"
+    },
+    {
+      "url": "https://staging.example.com",
+      "description": "Staging Server"
     }
   ],
   "security": [
@@ -104,14 +108,14 @@
     "schemas": {
       "PersonDTO": {
         "type": "object",
+        "description": "Description for PersonDTO component",
         "properties": {
           "name": {
             "type": "string",
             "description": "Description for 'name' property",
             "example": "Example value for 'name' property"
           }
-        },
-        "description": "Description for PersonDTO component"
+        }
       }
     },
     "securitySchemes": {
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app217-1.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app217-1.json
@@ -11,8 +11,8 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://demo.example.com",
+      "description": "demo Server"
     }
   ],
   "paths": {
@@ -41,14 +41,14 @@
     "schemas": {
       "PersonDTO": {
         "type": "object",
+        "description": "Description for PersonDTO component",
         "properties": {
           "name": {
             "type": "string",
             "description": "Description for 'name' property",
             "example": "Example value for 'name' property"
           }
-        },
-        "description": "Description for PersonDTO component"
+        }
       }
     }
   }
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app217-2.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app217-2.json
@@ -11,8 +11,8 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://user.example.com",
+      "description": "user Server"
     }
   ],
   "paths": {
@@ -41,14 +41,14 @@
     "schemas": {
       "PersonDTO": {
         "type": "object",
+        "description": "Description for PersonDTO component",
         "properties": {
           "name": {
             "type": "string",
             "description": "Description for 'name' property",
             "example": "Example value for 'name' property"
           }
-        },
-        "description": "Description for PersonDTO component"
+        }
       }
     }
   }
diff --git a/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app217.json b/springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app217.json
@@ -7,8 +7,12 @@
   },
   "servers": [
     {
-      "url": "http://localhost",
-      "description": "Generated server url"
+      "url": "https://api.example.com",
+      "description": "Production Server"
+    },
+    {
+      "url": "https://staging.example.com",
+      "description": "Staging Server"
     }
   ],
   "paths": {
@@ -37,14 +41,14 @@
     "schemas": {
       "PersonDTO": {
         "type": "object",
+        "description": "Description for PersonDTO component",
         "properties": {
           "name": {
             "type": "string",
             "description": "Description for 'name' property",
             "example": "Example value for 'name' property"
           }
-        },
-        "description": "Description for PersonDTO component"
+        }
       }
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`
`27`	`27`	`package org.springdoc.core.customizers;`
`28`	`28`
	`29`	`+import java.util.ArrayList;`
`29`	`30`	`import java.util.List;`
`30`	`31`	`import java.util.Map;`
`31`	`32`	`import java.util.function.Consumer;`
`@@ -144,6 +145,9 @@ private void customizeOpenApi(OpenAPI openApi, OpenAPI openApiProperties) {`
`144`	`145`	`if (!CollectionUtils.isEmpty(securityRequirementsProperties)) {`
`145`	`146`	`customizeSecurity(openApi, securityRequirementsProperties);`
`146`	`147`	`}`
	`148`	`+ if (!CollectionUtils.isEmpty(openApiProperties.getServers())) {`
	`149`	`+ openApi.setServers(new ArrayList<>(openApiProperties.getServers()));`
	`150`	`+ }`
`147`	`151`	`}`
`148`	`152`	`}`
`149`	`153`
`@@ -364,5 +368,4 @@ private void resolveSet(Consumer<List> setter, Supplier<List> getter) {`
`364`	`368`	`}`
`365`	`369`	`}`
`366`	`370`
`367`		`-`
`368`	`371`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@`
`11`	`11`	`},`
`12`	`12`	`"servers": [`
`13`	`13`	`{`
`14`		`- "url": "http://localhost",`
`15`		`- "description": "Generated server url"`
	`14`	`+ "url": "https://demo.example.com",`
	`15`	`+ "description": "demo Server"`
`16`	`16`	`}`
`17`	`17`	`],`
`18`	`18`	`"paths": {`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,12 @@`
`7`	`7`	`},`
`8`	`8`	`"servers": [`
`9`	`9`	`{`
`10`		`- "url": "http://localhost",`
`11`		`- "description": "Generated server url"`
	`10`	`+ "url": "https://api.example.com",`
	`11`	`+ "description": "Production Server"`
	`12`	`+ },`
	`13`	`+ {`
	`14`	`+ "url": "https://staging.example.com",`
	`15`	`+ "description": "Staging Server"`
`12`	`16`	`}`
`13`	`17`	`],`
`14`	`18`	`"paths": {`
`@@ -37,14 +41,14 @@`
`37`	`41`	`"schemas": {`
`38`	`42`	`"PersonDTO": {`
`39`	`43`	`"type": "object",`
	`44`	`+ "description": "Description for PersonDTO component",`
`40`	`45`	`"properties": {`
`41`	`46`	`"name": {`
`42`	`47`	`"type": "string",`
`43`	`48`	`"description": "Description for 'name' property",`
`44`	`49`	`"example": "Example value for 'name' property"`
`45`	`50`	`}`
`46`		`- },`
`47`		`- "description": "Description for PersonDTO component"`
	`51`	`+ }`
`48`	`52`	`}`
`49`	`53`	`}`
`50`	`54`	`}`