Skip to content
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

임시 파일 업로드 API 구현 #292

Merged
merged 1 commit into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions perfume-api/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,14 @@ include::{snippets}/get-mypage-reviews/http-request.adoc[]
include::{snippets}/get-mypage-reviews/http-response.adoc[]
include::{snippets}/get-mypage-reviews/response-fields.adoc[]

== 파일 업로드
=== 요청
include::{snippets}/file-upload/http-request.adoc[]

=== 응답
include::{snippets}/file-upload/http-response.adoc[]
include::{snippets}/file-upload/response-fields.adoc[]

== 샘플
=== 요청
include::{snippets}/index/http-request.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package io.perfume.api.file.adapter.in.http;

import io.perfume.api.file.adapter.in.http.dto.UpdateFileResponseDto;
import io.perfume.api.file.application.port.in.dto.FileResult;
import io.perfume.api.file.application.service.FileService;
import java.io.IOException;
import java.time.LocalDateTime;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.security.core.userdetails.User;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

@RestController
@RequestMapping("/api/v1/files")
@PreAuthorize("isAuthenticated()")
@RequiredArgsConstructor
public class FileController {

private final FileService fileService;

@PostMapping
public ResponseEntity<UpdateFileResponseDto> uploadFile(
@AuthenticationPrincipal final User user, final MultipartFile file) {
try {
final LocalDateTime now = LocalDateTime.now();
final long userId = Long.parseLong(user.getUsername());
final FileResult result = fileService.uploadFile(file.getBytes(), userId, now);

return ResponseEntity.ok(new UpdateFileResponseDto(result.id(), result.url()));
} catch (IOException e) {
return ResponseEntity.internalServerError().build();
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package io.perfume.api.file.adapter.in.http.dto;

public record UpdateFileResponseDto(long id, String url) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package io.perfume.api.file.application.port.in.dto;

public record FileResult(Long id, String url) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package io.perfume.api.file.application.service;

import io.perfume.api.file.application.port.in.dto.FileResult;
import io.perfume.api.file.application.port.out.FileRepository;
import io.perfume.api.file.domain.File;
import java.time.LocalDateTime;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class FileService {

private final FileRepository fileRepository;

public FileResult uploadFile(
final byte[] uploadFile, final long userId, final LocalDateTime now) {
// TODO: AWS S3에 파일 업로드
final File uploadedFile =
fileRepository.save(File.createFile("https://picsum.photos/200/300", userId, now));

return new FileResult(uploadedFile.getId(), uploadedFile.getUrl());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
package io.perfume.api.file.adapter.in.http;

import static org.junit.jupiter.api.Assertions.*;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.multipart;
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
import static org.springframework.restdocs.request.RequestDocumentation.partWithName;
import static org.springframework.restdocs.request.RequestDocumentation.requestParts;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.restdocs.RestDocumentationContextProvider;
import org.springframework.restdocs.RestDocumentationExtension;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.context.WebApplicationContext;

@ExtendWith({RestDocumentationExtension.class, SpringExtension.class})
@Transactional
@SpringBootTest
@SuppressWarnings("NonAsciiCharacters")
class FileControllerTest {

private MockMvc mockMvc;

@Autowired private ObjectMapper objectMapper;

@BeforeEach
void setUp(
WebApplicationContext webApplicationContext,
RestDocumentationContextProvider restDocumentation) {
this.mockMvc =
MockMvcBuilders.webAppContextSetup(webApplicationContext)
.apply(documentationConfiguration(restDocumentation))
.build();
}

@Test
@DisplayName("파일을 업로드한다.")
@WithMockUser(username = "1", roles = "USER")
void uploadFile() throws Exception {
// given
final MockMultipartFile file =
new MockMultipartFile("file", "test.txt", "text/plain", "file".getBytes());

// when & then
mockMvc
.perform(
multipart("/api/v1/files")
.file(file)
.characterEncoding("UTF-8")
.contentType("multipart/form-data"))
.andDo(
document(
"file-upload",
requestParts(partWithName("file").description("업로드할 파일")),
responseFields(
fieldWithPath("id").description("파일 식별자"),
fieldWithPath("url").description("파일 URL"))));
}
}