BE: Integrate Swagger UI for API documentation #631

api/build.gradle

@@ -26,6 +26,9 @@ dependencies {
     implementation libs.spring.security.oauth2.resource.server
     implementation libs.spring.boot.actuator
 
+    // For Swagger UI Webflux
+    implementation libs.springdoc.openapi.webflux
+
     compileOnly libs.spring.boot.devtools
 
     implementation libs.spring.security.ldap
@@ -172,6 +175,28 @@ tasks.register('buildDockerImageTask', DockerBuildImage) {
     images.add("ghcr.io/kafbat/kafka-ui:${project.version}")
 }
 
+tasks.register('copyOpenApiSpecForSwagger', Copy) {
+    dependsOn ':contract-typespec:build'
+
+    if (useTypeSpec) {
+        inputs.files(project(":contract-typespec").layout.buildDirectory.dir("tsp/api/openapi.yaml"))
+    } else {
+        inputs.files(fileTree("../contract/src/main/resources/swagger/"))
+    }
+    outputs.file("src/main/resources/static/openapi/kafbat-ui-api.yaml")
+
+    from useTypeSpec ?
+        project(":contract-typespec").layout.buildDirectory.dir("tsp/api/openapi.yaml").get() :
+        fileTree("../contract/src/main/resources/swagger/").matching { include "kafbat-ui-api.yaml" }
+    into "src/main/resources/static/openapi/"
+    rename { "kafbat-ui-api.yaml" }
+}
+
+
+tasks.named("processResources") {
+    dependsOn("copyOpenApiSpecForSwagger")
+}
+
 if (buildDockerImages) {
     tasks.build.finalizedBy buildDockerImageTask
 }
@@ -181,3 +206,4 @@ if (includeFrontend) {
         dependsOn(":frontend:buildFrontend")
     }
 }
+

api/src/main/java/io/kafbat/ui/config/auth/AbstractAuthSecurityConfig.java

@@ -33,6 +33,12 @@ protected AbstractAuthSecurityConfig() {
       "/actuator/info",
       "/actuator/prometheus",
 
+      /* SWAGGER UI */
+      "/swagger-ui/**",
+      "/v3/api-docs",
+      "/v3/api-docs/**",
+      "/webjars/**",
+
       /* AUTH */
       "/login",
       "/logout",

api/src/main/resources/application.yml

@@ -12,6 +12,18 @@ management:
       exposure:
         include: "info,health,prometheus"
 
+springdoc:
+  path: /swagger 
+  api-docs:
+    enabled: true
+  swagger-ui:
+    url: /openapi/kafbat-ui-api.yaml
+    urls:
+      - name: kafbat-ui
+        url: /openapi/kafbat-ui-api.yaml
+    config-url: null 
+  override-with-generic-response: true
+
 logging:
   level:
     root: INFO

gradle/libs.versions.toml

@@ -30,6 +30,7 @@ okhttp3 = '4.12.0'
 wiremock = '3.9.1'
 testcontainers = '1.20.6'
 swagger-integration-jakarta = '2.2.28'
+springdoc = '2.6.0'
 jakarta-annotation-api = '2.1.1'
 jackson-databind-nullable = '0.2.8'
 antlr = '4.13.2'
@@ -55,6 +56,7 @@ sonarqube = { id = "org.sonarqube", version = "6.0.1.5171" }
 spring-starter-actuator = { module = 'org.springframework.boot:spring-boot-starter-actuator', version.ref = 'spring-boot' }
 spring-starter-test = { module = 'org.springframework.boot:spring-boot-starter-test', version.ref = 'spring-boot' }
 spring-starter-webflux = { module = 'org.springframework.boot:spring-boot-starter-webflux', version.ref = 'spring-boot' }
+springdoc-openapi-webflux = { module = 'org.springdoc:springdoc-openapi-starter-webflux-ui', version.ref = 'springdoc' }
 spring-starter-security = { module = 'org.springframework.boot:spring-boot-starter-security', version.ref = 'spring-boot' }
 # Temporary overwrite to fix CVE-2025-53864
 nimbus-jose-jwt = { module = 'com.nimbusds:nimbus-jose-jwt', version.ref = 'nimbus-jose-jwt' }