Spring Boot 간단한 게시판 만들어보기 // POSTMAN

POSTMAN은 View 없이도 API 동작을 실험해볼 수 있는 도구.

 

 

<Spring Boot, Postman으로 게시판 CRUD 만들어보기>

JPA, h2(데이터베이스), Lombok 사용

 

<1> 디렉터리 생성

Controller // Repository // Service 디렉터리 만들어주기

+ DB의 테이블 역할을 할 entity,

+ 클라이언트의 Request 데이터를 받아올 DTO(Data Transfer Object) 디렉터리 생성

DTO 사용 이유 : API 간 필요한 데이터만 주고받을 수 있도록(노출 ↓) ==> https://www.okta.com/kr/identity-101/dto/

데이터 전송 객체(DTO) 정의 및 사용 방법 | Okta Identity Korea

 

<2> API 명세

귀찮아서 중괄호 생략..... 요청 url과 METHOD는 역할에 맞게.

같은 api/article/{id}로 PUT요청, DELETE요청에 따라 Controller에 의해 다른 메서드로 매핑된다.

REST 설계에서 요청 URL의 / 구분은 하나의 계층을 나타내도록 하고 있다.

 

<3> Entity, Repository 작성

Article entity

Entity는 NoArgsConstructor가 있어야함

 

ArticleRepository를 만들어주고 JPA를 연동함

이제 이 ArticleRepository 클래스를 내 데이터베이스처럼 사용할 수 있다.

 

<4> Controller 적절하게 만들어주기

ArticleController 클래스 안의 요청들은 /api를 타고 오도록 @RequestMapping

각 요청은 METHOD에 맞게 작성하면 되고, 변수는 클라이언트의 요청에 따라 적절하게 받아준다.

Controller에서는 적절한 DTO를 사용하여 클라이언트의 요청을 받고, 이에따른 적절한 Service함수를 호출한다.

Service에서 적절한 작업을 마치고 넘어온 DTO를 다시 클라이언트에게 반환해주면 끗

 

<5> Service 작성

클래스 내에 알맞은 Repository를 final 변수로 가지고, 들어오는 요청과 서비스로직에 따라 Repository에 CRUD 해준다.

작업을 마치면 ResponseDto에 담아 다시 Controller로 내려준다.

 

 

<PostMan으로 확인해보기>

https://web.postman.co/workspace

Postman API | Postman Public Workspace

가입하고, workspace 열어준다.

로컬환경에서 테스트해볼 경우, 오류가 나고 아래에 Postman agent 설치하도록 나온다.

설치해주면 localhost에 요청보낼수있다.

요청 URL과 METHOD를 알맞게 입력 후, 요청데이터를 담아보낼 방법을 선택한 후, 그에맞게 입력

오른쪽 SEND버튼을 누르면 아래에 응답이 뜬다.