-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature] FAQ 생성 기능 구현 #36
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
src/main/java/com/teamA/hicardi/domain/faq/controller/FaqController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
package com.teamA.hicardi.domain.faq.controller; | ||
|
||
import com.teamA.hicardi.common.dto.ResponseDto; | ||
import com.teamA.hicardi.domain.faq.dto.request.FaqSaveRequestDto; | ||
import com.teamA.hicardi.domain.faq.service.FaqService; | ||
import com.teamA.hicardi.error.dto.ErrorResponse; | ||
import io.swagger.v3.oas.annotations.Operation; | ||
import io.swagger.v3.oas.annotations.media.Content; | ||
import io.swagger.v3.oas.annotations.media.Schema; | ||
import io.swagger.v3.oas.annotations.responses.ApiResponse; | ||
import io.swagger.v3.oas.annotations.security.SecurityRequirement; | ||
import jakarta.validation.Valid; | ||
import lombok.RequiredArgsConstructor; | ||
import org.springframework.http.ResponseEntity; | ||
import org.springframework.web.bind.annotation.PostMapping; | ||
import org.springframework.web.bind.annotation.RequestBody; | ||
import org.springframework.web.bind.annotation.RequestMapping; | ||
import org.springframework.web.bind.annotation.RestController; | ||
|
||
@RestController | ||
@RequiredArgsConstructor | ||
@RequestMapping("/faq") | ||
public class FaqController { | ||
|
||
private final FaqService faqService; | ||
|
||
@Operation(summary = "FAQ 저장", description = "FAQ를 저장합니다.", | ||
security = { @SecurityRequirement(name = "bearer-key") }, | ||
responses = { | ||
@ApiResponse(responseCode = "204", description = "FAQ 저장 성공") | ||
, @ApiResponse(responseCode = "400", description = "1. 잘못된 카테고리입니다. \t\n 2. 질문은 필수 입력 값입니다. \t\n 3. 답변은 필수 입력 값입니다.", content = @Content(schema = @Schema(implementation = ErrorResponse.class))) | ||
}) | ||
@PostMapping | ||
public ResponseEntity<Void> saveFaq(@RequestBody @Valid FaqSaveRequestDto requestDto) { | ||
faqService.saveFaq(requestDto); | ||
return ResponseDto.noContent(); | ||
} | ||
|
||
|
||
} |
16 changes: 16 additions & 0 deletions
16
src/main/java/com/teamA/hicardi/domain/faq/dto/request/FaqSaveRequestDto.java
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 좋습니다. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
package com.teamA.hicardi.domain.faq.dto.request; | ||
|
||
import com.teamA.hicardi.domain.faq.entity.Category; | ||
import com.teamA.hicardi.domain.faq.entity.Faq; | ||
import jakarta.validation.constraints.NotBlank; | ||
|
||
public record FaqSaveRequestDto(String category, @NotBlank(message = "질문은 필수 입력 값입니다.") String question, @NotBlank(message = "답변은 필수 입력 값입니다.") String answer) { | ||
|
||
public Faq toEntity(Category category, String question, String answer) { | ||
return Faq.builder() | ||
.category(category) | ||
.question(question) | ||
.answer(answer) | ||
.build(); | ||
} | ||
} |
16 changes: 15 additions & 1 deletion
16
src/main/java/com/teamA/hicardi/domain/faq/entity/Category.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,19 @@ | ||
package com.teamA.hicardi.domain.faq.entity; | ||
|
||
import com.fasterxml.jackson.annotation.JsonCreator; | ||
import com.teamA.hicardi.error.ErrorCode; | ||
import com.teamA.hicardi.error.exception.custom.BusinessException; | ||
|
||
import java.util.stream.Stream; | ||
|
||
public enum Category { | ||
BATTERY, EXERCISE // 추가 예정 | ||
BATTERY, EXERCISE; // 추가 예정 | ||
|
||
@JsonCreator | ||
public static Category create(String requestValue) { | ||
return Stream.of(values()) | ||
.filter(v -> v.toString().equalsIgnoreCase(requestValue)) | ||
.findFirst() | ||
.orElseThrow(() -> new BusinessException(ErrorCode.INVALID_CATEGORY)); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
src/main/java/com/teamA/hicardi/domain/faq/repository/FaqRepository.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
package com.teamA.hicardi.domain.faq.repository; | ||
|
||
import com.teamA.hicardi.domain.faq.entity.Faq; | ||
import org.springframework.data.jpa.repository.JpaRepository; | ||
|
||
public interface FaqRepository extends JpaRepository<Faq, Long> { | ||
} |
25 changes: 25 additions & 0 deletions
25
src/main/java/com/teamA/hicardi/domain/faq/service/FaqService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
package com.teamA.hicardi.domain.faq.service; | ||
|
||
import com.teamA.hicardi.domain.faq.dto.request.FaqSaveRequestDto; | ||
import com.teamA.hicardi.domain.faq.entity.Category; | ||
import com.teamA.hicardi.domain.faq.entity.Faq; | ||
import com.teamA.hicardi.domain.faq.repository.FaqRepository; | ||
import lombok.RequiredArgsConstructor; | ||
import lombok.extern.slf4j.Slf4j; | ||
import org.springframework.stereotype.Service; | ||
import org.springframework.transaction.annotation.Transactional; | ||
|
||
@Slf4j | ||
@Service | ||
@Transactional | ||
@RequiredArgsConstructor | ||
public class FaqService { | ||
|
||
private final FaqRepository faqRepository; | ||
|
||
public void saveFaq(FaqSaveRequestDto requestDto) { | ||
Category category = Category.create(requestDto.category()); | ||
Faq faq = requestDto.toEntity(category, requestDto.question(), requestDto.answer()); | ||
faqRepository.save(faq); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
src/test/java/com/teamA/hicardi/domain/faq/controller/FaqControllerTest.java
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 굿 ! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
package com.teamA.hicardi.domain.faq.controller; | ||
|
||
import com.fasterxml.jackson.databind.ObjectMapper; | ||
import com.teamA.hicardi.domain.faq.dto.request.FaqSaveRequestDto; | ||
import com.teamA.hicardi.domain.faq.service.FaqService; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.ExtendWith; | ||
import org.mockito.InjectMocks; | ||
import org.mockito.Mock; | ||
import org.mockito.junit.jupiter.MockitoExtension; | ||
import org.springframework.http.MediaType; | ||
import org.springframework.test.web.servlet.MockMvc; | ||
import org.springframework.test.web.servlet.ResultActions; | ||
import org.springframework.test.web.servlet.setup.MockMvcBuilders; | ||
import org.springframework.web.filter.CharacterEncodingFilter; | ||
|
||
import static org.mockito.ArgumentMatchers.any; | ||
import static org.mockito.Mockito.times; | ||
import static org.mockito.Mockito.verify; | ||
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; | ||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; | ||
|
||
@ExtendWith(MockitoExtension.class) | ||
class FaqControllerTest { | ||
|
||
@InjectMocks | ||
private FaqController faqController; | ||
@Mock | ||
private FaqService faqService; | ||
private ObjectMapper objectMapper = new ObjectMapper(); | ||
private MockMvc mockMvc; | ||
|
||
@BeforeEach | ||
void setUp() { | ||
mockMvc = MockMvcBuilders.standaloneSetup(faqController) | ||
.addFilter(new CharacterEncodingFilter("UTF-8", true)) | ||
.build(); | ||
} | ||
|
||
@Test | ||
void FAQ_생성() throws Exception { | ||
//given | ||
FaqSaveRequestDto requestDto = new FaqSaveRequestDto("BATTERY", "질문입니다.", "답변입니다."); | ||
|
||
//when | ||
ResultActions result = mockMvc.perform( | ||
post("/faq") | ||
.contentType(MediaType.APPLICATION_JSON) | ||
.content(objectMapper.writeValueAsString(requestDto)) | ||
); | ||
|
||
//then | ||
result.andExpect(status().isNoContent()); | ||
verify(faqService, times(1)).saveFaq(any()); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
좋아요.