summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorputhuparambil.aditya <aditya.puthuparambil@bell.ca>2021-11-23 14:53:43 +0000
committerputhuparambil.aditya <aditya.puthuparambil@bell.ca>2021-11-23 14:53:43 +0000
commit1d90226c31817f562118c2f3d484e000d6c72cae (patch)
tree4d289d3f6a4014d4c23f0123e026ce1a6790c1b9
parent54340b00d3560955f67561185c9fbc1b63455d3c (diff)
Generating openapi documentation from openapi.yaml
Issue-ID: CPS-755 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: Ib19afce259639d0154e6dbeb825c5da0e3dbfa3a
-rw-r--r--pom.xml28
-rw-r--r--src/main/resources/application.yml8
2 files changed, 36 insertions, 0 deletions
diff --git a/pom.xml b/pom.xml
index 552d30fa..cc74f4c8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -93,6 +93,11 @@
</exclusions>
</dependency>
<dependency>
+ <groupId>org.springdoc</groupId>
+ <artifactId>springdoc-openapi-ui</artifactId>
+ <version>1.5.9</version>
+ </dependency>
+ <dependency>
<groupId>org.spockframework</groupId>
<artifactId>spock-core</artifactId>
<scope>test</scope>
@@ -200,6 +205,29 @@
</executions>
</plugin>
<plugin>
+ <artifactId>maven-resources-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-resources</id>
+ <phase>compile</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.basedir}/target/classes/static/api-docs</outputDirectory>
+ <resources>
+ <resource>
+ <directory>${project.basedir}/target/generated-sources/swagger/</directory>
+ <includes>
+ <include>openapi.yaml</include>
+ </includes>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>2.3.3.RELEASE</version>
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
index 1a3b843f..67cd28ee 100644
--- a/src/main/resources/application.yml
+++ b/src/main/resources/application.yml
@@ -74,3 +74,11 @@ logging:
console: "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
file: "%d %p %c{1.} [%t] %m%n"
file: dmi.log
+
+springdoc:
+ swagger-ui:
+ disable-swagger-default-url: true
+ urlsPrimaryName: query
+ urls:
+ - name: query
+ url: /api-docs/openapi.yaml \ No newline at end of file