1446 - Created Swagger UI for OpenAPI Specifications (#1473)

opendatadiscovery · Oct 18, 2023 · 35adc2c · 35adc2c
1 parent 3ca6572
commit 35adc2c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -23,6 +23,7 @@ jackson-databind-nullable = '0.2.6'
 jetbrains-annotations = '23.0.0'
 swagger-annotations = '2.2.11'
 springfox-core = '3.0.0'
+springdoc-openapi = '2.2.0'
 mapstruct = '1.5.3.Final'
 opentelemetry = '1.6.0'
 opentelemetry-alpha = '1.6.0-alpha'
@@ -80,6 +81,7 @@ jackson-yaml = { module = 'com.fasterxml.jackson.dataformat:jackson-dataformat-y
 jetbrains-annotations = { module = 'org.jetbrains:annotations', version.ref = 'jetbrains-annotations' }
 swagger-annotations = { module = 'io.swagger.core.v3:swagger-annotations', version.ref = 'swagger-annotations' }
 springfox-core = { module = 'io.springfox:springfox-core', version.ref = 'springfox-core' }
+springdoc-openapi = { module = 'org.springdoc:springdoc-openapi-starter-webflux-ui', version.ref = 'springdoc-openapi' }
 mapstruct = { module = 'org.mapstruct:mapstruct', version.ref = 'mapstruct' }
 mapstruct-processor = { module = 'org.mapstruct:mapstruct-processor', version.ref = 'mapstruct' }
 opentelemetry-api = { module = 'io.opentelemetry:opentelemetry-api', version.ref = 'opentelemetry' }

diff --git a/odd-platform-api/build.gradle b/odd-platform-api/build.gradle
@@ -45,6 +45,7 @@ dependencies {
     implementation libs.snappy.java
     implementation libs.minio
     implementation libs.okhttp
+    implementation libs.springdoc.openapi
 
     compileOnly libs.lombok
 

diff --git a/odd-platform-api/src/main/resources/application.yml b/odd-platform-api/src/main/resources/application.yml
@@ -10,6 +10,12 @@ spring:
   codec:
     max-in-memory-size: 20MB
 
+springdoc:
+  api-docs:
+    path: /api/v3/swagger-ui.html
+  swagger-ui:
+    path: /api/v3/api-docs
+
 session:
   # INTERNAL_POSTGRESQL, REDIS, IN_MEMORY
   provider: IN_MEMORY