docs: GetCompanySearchList Swagger #35

Author: oOccasio

src/main/java/sopt/comfit/company/controller/CompanyController.java

@@ -41,9 +41,8 @@ public PageDto<GetCompanyListResponseDto> getCompanyList(@RequestParam(required
         return companyService.getCompanyList(keyword, industryEnum, scaleEnum, sortEnum, isRecruited, pageable);
     }
 
-    @GetMapping("/search")
-    @SecurityRequirement(name= "JWT")
-    public List<CompanySearchResponseDto> getCompanySearchList(@RequestParam String keyword){
+    @Override
+    public List<GetCompanySearchResponseDto> getCompanySearchList(@RequestParam String keyword){
 
         return companyService.getCompanySearchList(keyword);
     }

src/main/java/sopt/comfit/company/controller/CompanySwagger.java

@@ -10,10 +10,7 @@
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestParam;
-import sopt.comfit.company.dto.response.FeaturedCompanyResponseDto;
-import sopt.comfit.company.dto.response.GetCompanyListResponseDto;
-import sopt.comfit.company.dto.response.GetCompanyResponseDto;
-import sopt.comfit.company.dto.response.GetSuggestionCompanyResponseDto;
+import sopt.comfit.company.dto.response.*;
 import sopt.comfit.global.annotation.LoginUser;
 import sopt.comfit.global.dto.CommonApiResponse;
 import sopt.comfit.global.dto.CustomErrorResponse;
@@ -52,6 +49,26 @@ PageDto<GetCompanyListResponseDto> getCompanyList(@RequestParam(required = false
                                                                   @RequestParam(required = false) String sort,
                                                                   @RequestParam(defaultValue = "1") int page,
                                                                   @RequestParam(required = false) Boolean isRecruited);
+    @Operation(
+            summary = "기업 검색 API",
+            description = "기업검색 API 입니다"
+    )
+    @ApiResponses({
+            @ApiResponse(responseCode = "200", description = "기업 검색 성공",
+                    content = @Content(mediaType = "application/json",
+                            schema = @Schema(implementation = CommonApiResponse.class))),
+
+            @ApiResponse(responseCode = "403", description = "권한 오류",
+                    content = @Content(mediaType = "application/json",
+                            schema = @Schema(implementation = CustomErrorResponse.class))),
+            @ApiResponse(responseCode = "401", description = "헤더값 오류",
+                    content = @Content(mediaType = "application/json",
+                            schema = @Schema(implementation = CustomErrorResponse.class)))
+    })
+    @GetMapping("/search")
+    @SecurityRequirement(name= "JWT")
+    List<GetCompanySearchResponseDto> getCompanySearchList(@RequestParam String keyword);
+
 
     @Operation(
             summary = "주요 기업 조회 API",

…o/response/CompanySearchResponseDto.java …esponse/GetCompanySearchResponseDto.javasrc/main/java/sopt/comfit/company/dto/response/CompanySearchResponseDto.java renamed to src/main/java/sopt/comfit/company/dto/response/GetCompanySearchResponseDto.java src/main/java/sopt/comfit/company/dto/response/CompanySearchResponseDto.java renamed to src/main/java/sopt/comfit/company/dto/response/GetCompanySearchResponseDto.java

@@ -2,12 +2,12 @@
 
 import sopt.comfit.company.domain.Company;
 
-public record CompanySearchResponseDto(
+public record GetCompanySearchResponseDto(
         Long id,
         String name
 ) {
-    public static CompanySearchResponseDto from(Company company) {
-        return new CompanySearchResponseDto(
+    public static GetCompanySearchResponseDto from(Company company) {
+        return new GetCompanySearchResponseDto(
                 company.getId(),
                 company.getName()
         );

src/main/java/sopt/comfit/company/service/CompanyService.java

@@ -1,11 +1,9 @@
 package sopt.comfit.company.service;
 
 import lombok.RequiredArgsConstructor;
-import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
-import org.springframework.web.bind.annotation.RequestParam;
 import sopt.comfit.company.domain.*;
 import sopt.comfit.company.dto.response.*;
 import sopt.comfit.company.exception.CompanyErrorCode;
@@ -47,10 +45,10 @@ public PageDto<GetCompanyListResponseDto> getCompanyList( String keyword,
     }
 
     @Transactional(readOnly = true)
-    public List<CompanySearchResponseDto> getCompanySearchList(String keyword){
+    public List<GetCompanySearchResponseDto> getCompanySearchList(String keyword){
 
         return companyRepository.searchByKeyword(keyword).stream()
-                .map(CompanySearchResponseDto::from)
+                .map(GetCompanySearchResponseDto::from)
                 .collect(Collectors.toList());
     }