ensure consistent OpenAPI controller/endpoint ordering

see https://springdoc.org/#properties
steve-community · Jan 5, 2025 · 415e1d5 · 415e1d5
1 parent 716b379
commit 415e1d5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/main/java/de/rwth/idsg/steve/config/ApiDocsConfiguration.java b/src/main/java/de/rwth/idsg/steve/config/ApiDocsConfiguration.java
@@ -60,6 +60,10 @@ public class ApiDocsConfiguration {
         System.setProperty("springdoc.swagger-ui.path", "/manager/swagger-ui/index.html");
         // We only want REST APIs here (de.rwth.idsg.steve.web.api package)
         System.setProperty("springdoc.paths-to-match", "/api/**");
+        // Sort controllers alphabetically by their path
+        System.setProperty("springdoc.swagger-ui.tagsSorter", "alpha");
+        // Sort endpoints (within a controller) alphabetically by their path
+        System.setProperty("springdoc.swagger-ui.operationsSorter", "alpha");
     }
 
     @Bean