Skip to content

Commit 28e4555

Browse files
authored
Merge pull request #574 from fs123/feature/issue-572-missing-swagger-ui-property
Add support for swagger-ui-property 'urls.primaryName'.
2 parents 3c96e31 + 52eaff1 commit 28e4555

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,8 @@ public class SwaggerUiConfigProperties {
160160

161161
private Direction groupsOrder = Direction.ASC;
162162

163+
private String urlsPrimaryName;
164+
163165
public void addGroup(String group) {
164166
SwaggerUrl swaggerUrl = new SwaggerUrl(group);
165167
urls.add(swaggerUrl);
@@ -204,6 +206,7 @@ public Map<String, Object> getConfigParameters() {
204206
SpringDocPropertiesUtils.put("oauth2RedirectUrl", oauth2RedirectUrl, params);
205207
SpringDocPropertiesUtils.put("url", url, params);
206208
put("urls", urls, params);
209+
SpringDocPropertiesUtils.put("urls.primaryName", urlsPrimaryName, params);
207210
return params;
208211
}
209212

@@ -407,6 +410,14 @@ public boolean isAscending() {
407410
}
408411
}
409412

413+
public String getUrlsPrimaryName() {
414+
return urlsPrimaryName;
415+
}
416+
417+
public void setUrlsPrimaryName(String urlsPrimaryName) {
418+
this.urlsPrimaryName = urlsPrimaryName;
419+
}
420+
410421
static class SwaggerUrl {
411422
private String url;
412423

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app4/SpringDocApp4Test.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
2929
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
3030

31-
@TestPropertySource(properties = "springdoc.swagger-ui.groups-order=DESC")
31+
@TestPropertySource(properties = {"springdoc.swagger-ui.groups-order=DESC", "springdoc.swagger-ui.urlsPrimaryName=pets"})
3232
public class SpringDocApp4Test extends AbstractSpringDocTest {
3333

3434
@Test
@@ -40,6 +40,7 @@ public void swagger_config_for_multiple_groups() throws Exception {
4040
.andExpect(jsonPath("urls[0].url", equalTo("/v3/api-docs/stores")))
4141
.andExpect(jsonPath("urls[0].name", equalTo("stores")))
4242
.andExpect(jsonPath("urls[1].url", equalTo("/v3/api-docs/pets")))
43-
.andExpect(jsonPath("urls[1].name", equalTo("pets")));
43+
.andExpect(jsonPath("urls[1].name", equalTo("pets")))
44+
.andExpect(jsonPath("$['urls.primaryName']", equalTo("pets")));
4445
}
4546
}

0 commit comments

Comments
 (0)