ArticleApiController

ArticleApiController는 RESTful API를 사용하여 게시판에 있는 게시글에 대한 CRUD(Create, Read, Update, Delete) 작업을 처리하는 컨트롤러입니다. ArticleController와 다르게 @RestContrller를 사용하였으며 그래서 따로 분류하였습니다. 코드와 주요 기능은 다음과 같습니다.

package tomato.classifier.api;

import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import tomato.classifier.dto.ArticleDto;
import tomato.classifier.entity.Article;
import tomato.classifier.repository.ArticleRepository;
import tomato.classifier.service.ArticleService;

import javax.transaction.Transactional;

@RestController
@RequestMapping("/article")
@RequiredArgsConstructor
public class ArticleApiController {

    private final ArticleService articleService;

    @PostMapping("/add")
    public ResponseEntity<ArticleDto> write(@RequestBody ArticleDto articleDto) {

        ArticleDto write = articleService.write(articleDto);

        return ResponseEntity.status(HttpStatus.OK).body(write);
    }

    @PatchMapping("/edit/{articleId}")
    public ResponseEntity<ArticleDto> edit(@PathVariable Integer articleId, @RequestBody ArticleDto articleDto) {

        ArticleDto updatedDto = articleService.edit(articleId, articleDto);

        return ResponseEntity.status(HttpStatus.OK).body(updatedDto);
    }

    @DeleteMapping("/delete/{articleId}")
    public ResponseEntity<Article> delete(@PathVariable Integer articleId) {

        Article deleted = articleService.delete(articleId);

        return ResponseEntity.status(HttpStatus.OK).body(deleted);
    }
}

사용된 애노테이션 및 코드

@RestController :

REST는 REpresentative State Transfer의 약자로 분산 시스템을 위한 아키텍처입니다. 네트워크를 경유해서 외부 서버에 접속하거나 필요한 정보를 불러오기 위한 구조라고 생각할 수 있습니다. 그리고 이 REST 개념을 바탕으로 설계된 시스템을 'RESTFul'이라고 표현합니다. 이런 RESTFul한 웹 서비스를 구축하기 위해 사용하는 것이 RestController 입니다.

Controller 어노테이션 vs RestController 어노테이션 차이점 : Controller()의 경우 Spring 내의 ViewResolver에 의해 view로 변환이 됩니다. 반면 restController()의 경우 문자열 "tmpPage"이 그대로 Body에 반환되는 것을 확인할 수 있습니다
- 참고 : https://velog.io/@donghokim1998/Controller와-RestController의-역할과-차이점은

@RequestMapping("/article") :

특정 URI로 요청을 보내면 Controller에서 어떠한 방식으로 처리할지 정의를 한다. 이때 들어온 요청을 특정 메서드와 매핑하기 위해 사용하는 것이 @RequestMapping입니다. 여기서는 기본 URI를 "/article"로 지정합니다. 즉, 이 컨트롤러의 엔드포인트들은 "/article"을 시작으로 합니다.

@RequiredArgsConstructor :

이 어노테이션은 Lombok 프로젝트에서 제공하는 기능으로, 클래스의 final 필드에 대한 생성자를 자동으로 생성합니다. 이 클래스에서는 ArticleService를 final로 선언하고 생성자에서 주입받고 있으므로, 이 어노테이션을 사용하여 생성자를 자동으로 생성합니다.

private final ArticleService articleService : ArticleService 인스턴스를 주입받는 필드입니다. 이 컨트롤러는 ArticleService를 통해 비즈니스 로직을 수행합니다.

@PostMapping("/add") 코드 (참고 : ArticleService)
- @RequestBody : HTTP 요청의 바디내용을 통째로 자바객체로 변환해서 매핑된 메소드 파라미터로 전달해줍니다.
- 받은 ArticleDto 객체를 ArticleService의 write 메서드로 전달하여 새로운 게시글을 추가합니다. 그리고 추가된 게시글의 정보를 ArticleDto 형태로 클라이언트에게 반환합니다.
@PatchMapping("/edit/{articleId}") 코드 (참고 : ArticleService)
- @PathVariable : 경로 변수를 표시하기 위해 메서드에 매개변수에 사용됩니다. 주로 상세 조회, 수정, 삭제와 같은 작업에서 리소스 식별자로 사용됩니다.
- HTTP PATCH 요청을 처리하는 메서드입니다. "/article/edit/{articleId}" 엔드포인트에 대한 요청을 처리하며, 클라이언트가 요청 본문에 ArticleDto와 articleId를 담아서 보내면 이를 받아서 ArticleService의 edit 메서드를 호출합니다. 그 후, 해당 메서드는 업데이트된 ArticleDto를 반환합니다.
@DeleteMapping("/delete/{articleId}") 코드 (참고 : ArticleService)
- HTTP DELETE 요청을 처리하는 메서드입니다. 클라이언트가 articleId를 경로 변수로 전달하여 특정 article을 삭제하는 요청을 보냅니다. 그 후, 해당 메서드는 삭제된 Article 객체를 반환합니다.