Add Swagger API documentation with SpringDoc OpenAPI 3 integration

pom.xml

@@ -31,31 +31,24 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-log4j2</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>2.4.0</version>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <optional>true</optional>
-        </dependency>
     </dependencies>
 
     <build>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
-                <configuration>
-                    <excludes>
-                        <exclude>
-                            <groupId>org.project-lombok</groupId>
-                            <artifactId>lombok</artifactId>
-                        </exclude>
-                    </excludes>
-                </configuration>
             </plugin>
         </plugins>
     </build>

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));
+    }
+}

src/main/resources/application.yml

@@ -6,3 +6,9 @@ spring:
 server:
   port: 8080
 
+springdoc:
+  swagger-ui:
+    path: /swagger-ui.html
+app:
+  openapi:
+    endpoint: http://localhost:8080