feat: 학과 조회 API (#228)

Author: kmw10693

build.gradle

@@ -1,6 +1,9 @@
+// 1. Import 추가
+import org.hidetake.gradle.swagger.generator.GenerateSwaggerUI
+
 buildscript {
 	ext {
-		restdocsApiSpecVersion = '0.17.1' // restdocsApiSpecVersion 버전 변수 설정
+		restdocsApiSpecVersion = '0.18.3' // restdocsApiSpecVersion 버전 변수 설정
 	}
 }
 
@@ -9,17 +12,76 @@ plugins {
 	id 'org.springframework.boot' version '3.3.4'
 	id 'io.spring.dependency-management' version '1.1.6'
 	id 'org.asciidoctor.jvm.convert' version '3.3.2'
-	id "com.gorylenko.gradle-git-properties" version "2.4.1"
 	// epages-restdocs 플러그인 추가
 	id 'com.epages.restdocs-api-spec' version "${restdocsApiSpecVersion}"
-	// swagger generator 플러그인 추가
+	//swagger generator 플러그인 추가
 	id 'org.hidetake.swagger.generator' version '2.18.2'
 	id 'jacoco'
 }
 
 group = 'ku-rum'
 version = '0.0.1-SNAPSHOT'
 
+jacoco {
+	toolVersion = "0.8.8"
+	reportsDirectory = layout.buildDirectory.dir('customJacocoReportDir')
+}
+
+test {
+	finalizedBy jacocoTestReport // test 작업이 끝나고 jacocoTestReport를 실행
+}
+
+jacocoTestReport {
+	dependsOn test // test 종속성 추가
+
+	reports {
+		xml.required = true
+		csv.required = false
+		html.required = true
+	}
+
+	def QDomainList = []
+	for (qPattern in '**/QA'..'**/QZ') { // QClass 대응
+		QDomainList.add(qPattern + '*')
+	}
+
+	afterEvaluate {
+		classDirectories.setFrom(files(classDirectories.files.collect {
+			fileTree(dir: it, exclude: [
+					'**/dto/**',
+					'**/event/**',
+					'**/*InitData*',
+					'**/*Application*',
+					'**/exception/**',
+					'**/service/alarm/**',
+					'**/aop/**',
+					'**/config/**',
+					'**/MemberRole*',
+					'**/oauth/**'
+			] + QDomainList)
+		}))
+	}
+
+	finalizedBy 'jacocoTestCoverageVerification' // jacocoTestReport 태스크가 끝난 후 실행
+}
+
+jacocoTestCoverageVerification {
+	violationRules {
+
+		rule {
+			enabled = true
+			//코드 버커리지 체크 기준
+			element = 'CLASS'
+
+			limit {
+				counter = 'CLASS'
+				value = 'COVEREDRATIO'
+				minimum = 0.0
+			}
+		}
+	}
+}
+
 java {
 	toolchain {
 		languageVersion = JavaLanguageVersion.of(17)
@@ -30,15 +92,29 @@ configurations {
 	compileOnly {
 		extendsFrom annotationProcessor
 	}
-	asciidoctorExt
 }
 
 repositories {
 	mavenCentral()
 }
 
-ext{
-	set("snippetsDir", file("build/generated-snippets"))
+// 5. 생성된 API 스펙이 어느 위치에 있는지 지정
+swaggerSources {
+	sample {
+		setInputFile(file("${project.buildDir}/api-spec/openapi3.yaml"))
+	}
+}
+
+// 6. openapi3 스펙 생성시 설정 정보
+openapi3 {
+	servers = [
+			{ url = "https://kuroom.shop" },
+			{ url = "http://localhost:8080" }
+	]
+	title = "쿠룸 백엔드 API 문서"
+	description = "RestDocs를 이용한 Swagger API 문서입니다."
+	version = "1.0"
+	format = "yaml"
 }
 
 dependencies {
@@ -122,129 +198,49 @@ dependencies {
 
 }
 
-jacoco {
-	toolVersion = "0.8.8"
-	reportsDirectory = layout.buildDirectory.dir('customJacocoReportDir')
-}
-
-test {
-	finalizedBy jacocoTestReport // test 작업이 끝나고 jacocoTestReport를 실행
-}
-
-jacocoTestReport {
-	dependsOn test // test 종속성 추가
-
-	reports {
-		xml.required = true
-		csv.required = false
-		html.required = true
-	}
-
-	def QDomainList = []
-	for (qPattern in '**/QA'..'**/QZ') { // QClass 대응
-		QDomainList.add(qPattern + '*')
-	}
-
-	afterEvaluate {
-		classDirectories.setFrom(files(classDirectories.files.collect {
-			fileTree(dir: it, exclude: [
-					'**/dto/**',
-					'**/event/**',
-					'**/*InitData*',
-					'**/*Application*',
-					'**/exception/**',
-					'**/service/alarm/**',
-					'**/aop/**',
-					'**/config/**',
-					'**/MemberRole*',
-					'**/oauth/**'
-			] + QDomainList)
-		}))
-	}
-
-	finalizedBy 'jacocoTestCoverageVerification' // jacocoTestReport 태스크가 끝난 후 실행
-}
-
-jacocoTestCoverageVerification {
-	violationRules {
-
-		rule {
-			enabled = true
-			//코드 버커리지 체크 기준
-			element = 'CLASS'
-
-			limit {
-				counter = 'CLASS'
-				value = 'COVEREDRATIO'
-				minimum = 0.0
-			}
-		}
-	}
-}
 
 tasks.named('test') {
-	outputs.dir snippetsDir
 	useJUnitPlatform()
 }
 
-tasks.register("restDocsTest", Test) {
-	outputs.dir snippetsDir
-	useJUnitPlatform {
-		includeTags("restDocs")
-	}
-
-	finalizedBy "openapi3"
-}
-
-tasks.named("asciidoctor") {
-	dependsOn restDocsTest
-
-	inputs.dir snippetsDir
-	configurations "asciidoctorExt"
-	baseDirFollowsSourceDir() // 원본파일작업은 .adoc 디렉터리 기준
-}
-
-openapi3 {
-	servers = [
-			{ url = "https://kuroom.shop" },
-			{ url = "http://localhost:8080" }
-	]
-	title = "API 문서"
-	description = "RestDocsWithSwagger Docs"
-	version = "0.0.1"
-	format = "yaml"
+tasks.named('jar') {
+	enabled = false
 }
 
-tasks.register("apiBuild", GradleBuild) {
-	tasks = ["clean", "restDocsTest", "build"]
-}
+// 10. openapi3가 먼저 실행
+tasks.withType(GenerateSwaggerUI) {
+	dependsOn 'openapi3'
+	doFirst {
+		def swaggerUIFile = file("${openapi3.outputDirectory}/openapi3.yaml")
 
-springBoot {
-	buildInfo()
-}
+		/*	def securitySchemesContent =  "  securitySchemes:\n" +  \
+                                          "    APIKey:\n" +  \
+                                          "      type: apiKey\n" +  \
+                                          "      name: Authorization\n" +  \
+                                          "      in: header\n" + \
+                                          "security:\n" +
+                    "  - APIKey: []  # Apply the security scheme here"
 
-gitProperties {
-	dateFormat = "yyyy-MM-dd'T'HH:mm:ss.Zz"
-	dateFormatTimeZone = "Asia/Seoul"
-	failOnNoGitDirectory = false
-}
-
-bootJar {
-	from("swagger-ui") {
-		into "BOOT-INF/classes/static/swagger"
-	}
-	from("${asciidoctor.outputDir}") {
-		into "BOOT-INF/classes/static/docs"
+            swaggerUIFile.append securitySchemesContent*/
 	}
-	from("build/api-spec") {
-		into "BOOT-INF/classes/static/swagger"
-	}
-
-	archiveFileName.set "application.jar"
 }
 
 def querydslSrcDir = 'src/main/generated'
 
 clean {
 	delete file(querydslSrcDir)
 }
+
+//tasks.register("copySwaggerDocs", Copy) {
+//	dependsOn generateSwaggerUISample
+//	from("${generateSwaggerUISample.outputDir}")
+//	into("${project.projectDir}/src/main/resources/static/docs")
+//}
+
+// 11. 생성된 openapi3 스펙을 기반으로 SwaggerUISample 생성 및 static/docs 패키지에 복사
+bootJar {
+	dependsOn generateSwaggerUISample
+	from("${generateSwaggerUISample.outputDir}") {
+		into 'static/docs'
+	}
+}

src/main/java/ku_rum/backend/domain/college/application/CollegeQueryService.java

@@ -0,0 +1,27 @@
+package ku_rum.backend.domain.college.application;
+
+import ku_rum.backend.domain.college.domain.College;
+import ku_rum.backend.domain.college.domain.repository.CollegeRepository;
+import ku_rum.backend.domain.college.dto.response.CollegeResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.List;
+
+@Service
+@RequiredArgsConstructor
+@Transactional(readOnly = true)
+public class CollegeQueryService {
+    private final CollegeRepository collegeRepository;
+
+    public CollegeResponse findAll() {
+        List<College> all = collegeRepository.findAll();
+
+        List<String> names = all.stream()
+                .map(College::getName)
+                .toList();
+
+        return new CollegeResponse(names);
+    }
+}

src/main/java/ku_rum/backend/domain/college/domain/repository/CollegeRepository.java

@@ -4,4 +4,5 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 
 public interface CollegeRepository extends JpaRepository<College, Long> {
+
 }

src/main/java/ku_rum/backend/domain/college/dto/response/CollegeResponse.java

@@ -0,0 +1,6 @@
+package ku_rum.backend.domain.college.dto.response;
+
+import java.util.List;
+
+public record CollegeResponse(List<String> name) {
+}

src/main/java/ku_rum/backend/domain/college/presentation/CollegeQueryController.java

@@ -0,0 +1,22 @@
+package ku_rum.backend.domain.college.presentation;
+
+import ku_rum.backend.domain.college.application.CollegeQueryService;
+import ku_rum.backend.domain.college.dto.response.CollegeResponse;
+import ku_rum.backend.global.support.response.BaseResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/v1/colleges")
+@RequiredArgsConstructor
+public class CollegeQueryController {
+
+    private final CollegeQueryService collegeQueryService;
+
+    @GetMapping
+    public BaseResponse<CollegeResponse> getCollege() {
+        return BaseResponse.ok(collegeQueryService.findAll());
+    }
+}

src/main/java/ku_rum/backend/domain/department/application/DepartmentQueryService.java

@@ -2,13 +2,16 @@
 
 import ku_rum.backend.domain.department.domain.Department;
 import ku_rum.backend.domain.department.domain.repository.DepartmentRepository;
+import ku_rum.backend.domain.department.dto.CollegeDepartmentResponse;
 import ku_rum.backend.domain.user.dto.request.UserSaveRequest;
 import ku_rum.backend.global.exception.department.NoSuchDepartmentException;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.util.List;
+
 import static ku_rum.backend.global.support.status.BaseExceptionResponseStatus.NO_SUCH_DEPARTMENT;
 
 @Service
@@ -24,4 +27,10 @@ public Department getDepartment(final UserSaveRequest userSaveRequest) {
         return departmentRepository.findFirstByName(userSaveRequest.department())
                 .orElseThrow(() -> new NoSuchDepartmentException(NO_SUCH_DEPARTMENT));
     }
+
+    public CollegeDepartmentResponse getDepartmentsByCollege(final String college) {
+        List<Department> departments = departmentRepository.findAllByCollege_Name(college);
+        List<String> list = departments.stream().map(Department::getName).toList();
+        return new CollegeDepartmentResponse(list);
+    }
 }

src/main/java/ku_rum/backend/domain/department/domain/repository/DepartmentRepository.java

@@ -4,10 +4,12 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
+import java.util.List;
 import java.util.Optional;
 
 @Repository
 public interface DepartmentRepository extends JpaRepository<Department, Long> {
     boolean existsByName(String name);
     Optional<Department> findFirstByName(String name);
+    List<Department> findAllByCollege_Name(String college);
 }

src/main/java/ku_rum/backend/domain/department/dto/CollegeDepartmentResponse.java

@@ -0,0 +1,6 @@
+package ku_rum.backend.domain.department.dto;
+
+import java.util.List;
+
+public record CollegeDepartmentResponse(List<String> name) {
+}