From 69e6df5343649c29dc6ec542a3aa69599ceaddba Mon Sep 17 00:00:00 2001
From: Faiz Akram <156657523+faizorg@users.noreply.github.com>
Date: Sun, 24 Mar 2024 21:59:38 +0530
Subject: [PATCH 1/4] Swagger progress
---
pom.xml | 6 ++-
.../java/com/app/config/OpenAPIConfig.java | 42 +++++++++++++++++++
src/main/resources/application.yml | 12 ++++--
3 files changed, 56 insertions(+), 4 deletions(-)
create mode 100644 src/main/java/com/app/config/OpenAPIConfig.java
diff --git a/pom.xml b/pom.xml
index 24a58e3..a626a58 100644
--- a/pom.xml
+++ b/pom.xml
@@ -21,7 +21,11 @@
org.springframework.boot
spring-boot-starter-web
-
+
+ org.springdoc
+ springdoc-openapi-starter-webmvc-api
+ 2.4.0
+
org.springframework.boot
spring-boot-starter-test
diff --git a/src/main/java/com/app/config/OpenAPIConfig.java b/src/main/java/com/app/config/OpenAPIConfig.java
new file mode 100644
index 0000000..4a91b0a
--- /dev/null
+++ b/src/main/java/com/app/config/OpenAPIConfig.java
@@ -0,0 +1,42 @@
+package com.app.config;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.servers.Server;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.util.List;
+
+@Configuration
+public class OpenAPIConfig {
+
+ @Value("${app.openapi.endpoint}")
+ private String applicationEndpoint;
+
+ @Bean
+ public OpenAPI myOpenAPI() {
+ Server devServer = new Server();
+ devServer.setUrl(applicationEndpoint);
+ devServer.setDescription("Server Endpoint");
+
+ Contact contact = new Contact();
+ contact.setEmail("faiz.krm@gmail.com");
+ contact.setName("Faiz Akram");
+ contact.setUrl("https://www.faizkram.com");
+
+ License mitLicense = new License().name("Development License").url("https://www.faizkram.com");
+
+ Info info = new Info()
+ .title("Tutorial Management API")
+ .version("1.0")
+ .contact(contact)
+ .description("This API exposes endpoints to manage tutorials.").termsOfService("https://www.faizkram.com")
+ .license(mitLicense);
+
+ return new OpenAPI().info(info).servers(List.of(devServer));
+ }
+}
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
index 56fbd1d..a3d9604 100644
--- a/src/main/resources/application.yml
+++ b/src/main/resources/application.yml
@@ -1,6 +1,12 @@
spring:
- application:
- name: QuickStartSpringBoot
+ application:
+ name: QuickStartSpringBoot
server:
- port: 8080
+ port: 8080
+springdoc:
+ swagger-ui:
+ path: /swagger-ui.html
+app:
+ openapi:
+ endpoint: http://localhost:8080
\ No newline at end of file
From 955c9c18db40d6c4b6bdee890ee0501d2e2a3028 Mon Sep 17 00:00:00 2001
From: "IIPL\\14261"
Date: Thu, 5 Sep 2024 15:57:57 +0530
Subject: [PATCH 2/4] Add Swagger API documentation
---
src/main/resources/application.yml | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
index ae67d0a..0e56644 100644
--- a/src/main/resources/application.yml
+++ b/src/main/resources/application.yml
@@ -1,6 +1,8 @@
spring:
- application:
- name: QuickStartSpringBoot
+ profiles:
+ active: local
+ application:
+ name: QuickStartSpringBoot
server:
port: 8080
From 8d8101f545db83ecd94e93306f4d6a85a0fb97f9 Mon Sep 17 00:00:00 2001
From: Faiz Akram <156657523+faizorg@users.noreply.github.com>
Date: Mon, 20 Jan 2025 21:41:18 +0530
Subject: [PATCH 3/4] Maven updated
---
pom.xml | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/pom.xml b/pom.xml
index e536c72..31d382f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -31,6 +31,11 @@
org.springframework.boot
spring-boot-starter-log4j2
+
+ org.springdoc
+ springdoc-openapi-starter-webmvc-ui
+ 2.4.0
+
org.springdoc
springdoc-openapi-starter-webmvc-api
From 02fbb0ec7889c9c2eb7fc9e9900cc4a3f3249a24 Mon Sep 17 00:00:00 2001
From: Faiz Akram <156657523+faizorg@users.noreply.github.com>
Date: Mon, 20 Jan 2025 21:42:02 +0530
Subject: [PATCH 4/4] Maven updated
---
pom.xml | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/pom.xml b/pom.xml
index 31d382f..149851f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -36,11 +36,7 @@
springdoc-openapi-starter-webmvc-ui
2.4.0
-
- org.springdoc
- springdoc-openapi-starter-webmvc-api
- 2.4.0
-
+
org.springframework.boot
spring-boot-starter-test