ARTICLE AD BOX
I'm trying to understand the relationship between groups and URLs in Springdoc.
For example, we might have the following Springdoc configuration:
springdoc.swagger-ui.urls[0].url=${springdoc.swagger-ui.url}/myapp-api.yaml springdoc.swagger-ui.urls[0].name=randomName springdoc.group-configs[0].display-name=MyApp API springdoc.group-configs[0].group=myapp-api.yaml springdoc.group-configs[0].paths-to-match=${paths.to.match}I do not understand the purpose of springdoc.group-configs[0].display-name if it is not used anywhere. Where is it supposed to be displayed? In the UI, another property appears to control this. Specifically, SwaggerUrl objects are used to construct the group's displayName in the UI. The following excerpt from AbstractSwaggerUiConfigProperties illustrates this:
public SwaggerUrl(String group, String url, String displayName) { Objects.requireNonNull(group, GROUP_NAME_NOT_NULL); this.url = url; this.name = group; this.displayName = StringUtils.defaultIfEmpty(displayName, this.name); }As a result, the final display name is simply the name of the URL ("randomName" instaead of "MyApp API") , that is, springdoc.swagger-ui.urls[0].name, unless a general display name for all URLs is set. This behavior seems unusual because there is only a single displayName property for all URLs, which means it cannot be configured individually for each one.
So, what is the purpose of the property springdoc.group-configs[0].display-name, and where is it actually used or displayed, given that the Swagger UI appears to derive the group display name from SwaggerUrl configuration instead? More generally, what is the relation between URLs and Groups?
