Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
package dmu.dasom.api.domain.news.controller;

import dmu.dasom.api.domain.news.dto.NewsRequestDto;
import dmu.dasom.api.domain.news.dto.NewsResponseDto;
import dmu.dasom.api.domain.news.service.NewsService;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import java.util.List;

@Tag(name = "NEWS API", description = "다솜소식 API")
@RestController
@RequestMapping("/news")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

엔드포인트는 /api 로 시작하는 걸로 통일할게용
(ex. /api/news)

public class NewsController {

private final NewsService newsService;

public NewsController(NewsService newsService) {
this.newsService = newsService;
}

@Operation(summary = "소식 조회", description = "리스트로 조회")
@ApiResponse(responseCode = "200", description = "정상 응답",
content = @Content(mediaType = "application/json"))
@GetMapping
public ResponseEntity<List<NewsResponseDto>> getAllNews() {
List<NewsResponseDto> newsList = newsService.getAllNews();
return ResponseEntity.ok(newsList);
}

@Operation(summary = "소식 등록", description = "새로운 소식을 등록")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "생성 완료"),
@ApiResponse(responseCode = "400", description = "유효하지 않은 요청 데이터",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Request Body -> NewsRequestDto 역직렬화 과정에서 필드 값 Validation을 하기 위해서는 NewsRequestDto 선언부 앞에 @Valid 어노테이션을 추가하고 NewsRequestDto의 각 필드에 제약 조건을 설정하면 됩니다. ApplicantCreateRequestDto를 참고해보세요

content = @Content(mediaType = "application/json",
examples = @ExampleObject(value = "{ \"errorCode\": \"E003\", \"errorMessage\": \"유효하지 않은 입력입니다.\" }")))
})

@PostMapping
public ResponseEntity<NewsResponseDto> createNews(@RequestBody NewsRequestDto requestDto) {
NewsResponseDto responseDto = newsService.createNews(requestDto);
return ResponseEntity.status(201).body(responseDto);
}

}
24 changes: 24 additions & 0 deletions src/main/java/dmu/dasom/api/domain/news/dto/NewsRequestDto.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package dmu.dasom.api.domain.news.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
@Schema(description = "뉴스 요청 DTO")
public class NewsRequestDto {

@Schema(description = "뉴스 제목", example = "새로운 뉴스 제목")
@NotNull
private String title;

@Schema(description = "뉴스 내용", example = "새로운 뉴스 내용")
@NotNull
private String content;

@Schema(description = "뉴스 이미지 URL", example = "http://example.com/new-image.jpg")
private String imageUrl;

}
34 changes: 34 additions & 0 deletions src/main/java/dmu/dasom/api/domain/news/dto/NewsResponseDto.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package dmu.dasom.api.domain.news.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;

import java.time.LocalDateTime;

@Getter
@Schema(description = "응답 DTO")
public class NewsResponseDto {

@Schema(description = "소식 ID", example = "1")
private Long id;

@Schema(description = "제목", example = "제목")
private String title;

@Schema(description = "내용", example = "내용")
private String content;

@Schema(description = "작성일", example = "2025-02-14T12:00:00")
private LocalDateTime createdAt;

@Schema(description = "이미지 URL", example = "http://example.com/image.jpg")
private String imageUrl;

public NewsResponseDto(Long id, String title, String content, LocalDateTime createdAt, String imageUrl) {
this.id = id;
this.title = title;
this.content = content;
this.createdAt = createdAt;
this.imageUrl = imageUrl;
}
}
40 changes: 40 additions & 0 deletions src/main/java/dmu/dasom/api/domain/news/entity/NewsEntity.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package dmu.dasom.api.domain.news.entity;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;

import jakarta.persistence.*;
import jakarta.validation.constraints.NotNull;
import lombok.Getter;
import lombok.Setter;

import java.time.LocalDateTime;

@Getter
@Setter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setter를 사용하는 곳이 없다면 어노테이션은 제거해주세요

@Entity
@Schema(description = "뉴스 엔티티")
public class NewsEntity {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BaseEntity 상속받아서 생성일, 수정일, 상태 필드 구성하면 될 것 같습니다


@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Schema(description = "뉴스 ID", example = "1")
private Long id;

@Schema(description = "뉴스 제목", example = "뉴스 예제 제목")
@NotNull
private String title;

@Schema(description = "뉴스 내용", example = "뉴스 예제 내용")
@NotNull
@Column(columnDefinition = "TEXT")
private String content;

@Schema(description = "뉴스 작성일", example = "2025-02-14T12:00:00")
private LocalDateTime createdAt;

@Schema(description = "뉴스 이미지 URL", example = "http://example.com/image.jpg")
private String imageUrl;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이미지는 외부 DB에 저장하는 건가요?

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package dmu.dasom.api.domain.news.repository;

import dmu.dasom.api.domain.news.entity.NewsEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface NewsRepository extends JpaRepository<NewsEntity, Long> {
}
38 changes: 38 additions & 0 deletions src/main/java/dmu/dasom/api/domain/news/service/NewsService.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package dmu.dasom.api.domain.news.service;

import dmu.dasom.api.domain.news.dto.NewsRequestDto;
import dmu.dasom.api.domain.news.dto.NewsResponseDto;
import dmu.dasom.api.domain.news.entity.NewsEntity;
import dmu.dasom.api.domain.news.repository.NewsRepository;
import org.springframework.stereotype.Service;
import java.time.LocalDateTime;
import java.util.List;
import java.util.stream.Collectors;

@Service
public class NewsService {

private final NewsRepository newsRepository;

public NewsService(NewsRepository newsRepository) {
this.newsRepository = newsRepository;
}

public List<NewsResponseDto> getAllNews() {
return newsRepository.findAll().stream()
.map(news -> new NewsResponseDto(news.getId(), news.getTitle(), news.getContent(), news.getCreatedAt(), news.getImageUrl()))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

News 엔티티 클래스 내부에 Dto 변환 메소드를 구현하면 더 깔끔하게 구현 가능합니다
Applicant 메소드 참고해보세용

.collect(Collectors.toList());
}

public NewsResponseDto createNews(NewsRequestDto requestDto) {
NewsEntity news = new NewsEntity();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setter를 이용해 객체 필드를 초기화하는 것보단 생성자나 Builder 패턴을 이용해서 인스턴스 생성과 동시에 초기화 하는 것이 더 적절합니다.
setter를 쓰게 되면 인스턴스 생성 후 객체 내부 상태를 변경하는 행위가 되는 것인데, 인스턴스 생성 이외의 상태 변경은 별도의 update 메소드 같이 도메인 로직 내에서 명시적으로 허용된 경우에만 이루어져야합니다.

news.setTitle(requestDto.getTitle());
news.setContent(requestDto.getContent());
news.setImageUrl(requestDto.getImageUrl());
news.setCreatedAt(LocalDateTime.now());

NewsEntity savedNews = newsRepository.save(news);
return new NewsResponseDto(savedNews.getId(), savedNews.getTitle(), savedNews.getContent(), savedNews.getCreatedAt(), savedNews.getImageUrl());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

마찬가지로 Entity -> Dto 변환 메소드를 엔티티 내부에 구현하면 깔끔합니다

}

}