[Youtube project] REST API 설계해보기

이전까지 만든 ERD와 한방쿼리들을 바탕으로 아주 간단한 유튜브 RestAPI를 설계해보았다.

 

🍋 RestAPI가 뭔가요?

 

REST란 Representational State Transfer의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고 받는 모든 것을 의미한다. 

REST는

• 자원(RESOURCE) - URI
• 행위(Verb) - HTTP METHOD
• 표현(Representations)

로 구성되어있다.

 

REST API를 설계할 때 두가지를 꼭 기억해야한느데

1. URI는 정보의 자원을 표시해야한다.

2. 자원에 대한 행위는 HTTP Method(GET,POST,PUSH,DELETE)로 표현한다.

 

두번째 내용은 어찌보면 URI에 동사가 들어가면 안된다는 것과 같다.

 

REST API의 예시를 보여주면

 

[POST] /users 는 새로운 유저 등록을 의미한다.

[GET] /users는 전체 유저 조회를 의미한다.

[PATCH] /users/userID/1 은 userID가 1인 유저의 정보를 수정한다는 것을 의미한다.

[PATCH] /users/d/userID/1 은 userID가 1인 유저의 정보를 삭제하는 것을 의미한다. 

 

https://meetup.toast.com/posts/92

REST API 제대로 알고 사용하기 : NHN Cloud Meetup

 

https://khj93.tistory.com/entry/%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC-REST-API%EB%9E%80-REST-RESTful%EC%9D%B4%EB%9E%80

[네트워크] REST API란? REST, RESTful이란?

🍋 API 리스트업 해보기

 

위와 같이 구성해보았다. DELETE의 경우는 버리는 데이터가 없기에 삭제하고 싶은 정보의 경우 status만 d로 바꾸었다. 

RestAPI를 짜면서 아쉬웠던건 기능별로 API를 짰어야 했는데 화면별로 API를 짜다보니 동일한 쿼리를 또 넣고 해버려서 일을 여러번 하는 꼴이 되어버렸다. 다음번엔 화면보단 기능위주로 짜보자.!

 

💙 REST API 명세서

 

API명세서 최종.xlsx

4.15MB

🍋 스프링부트로 구현

 

나는 스프링부트 프로젝트를 Controller,Service(CUD),Provider(Read),Dao로 구성했다.

 

모든 영상을 조회하는 API를 만드는 과정을 Controller,Service,Provider,Dao를 통해  설명해보겠다. 

 

먼저 Controller단 부터 보자. 

 

클래스 바깥에 RestController와 RequestMapping 설정을 해준다. 

 

getVideos 함수 위에 GET 메서드의 URI를 표시해주는 GetMapping 어노테이션을 추가해준다.

영상을 조회하면 여러 영상의 정보들이 나와야하기에 List로 받아줄 것이다.

 

 

여긴 Provider단인데, Provider는 조회를 하고, Service는 Create,Update,Delete를 할 수 있게 기능을 나눴다. 이번에는 전체 영상조회를 해야하기에 Provider에서 작업을 해야한다. 

 

마지막은 핵심인 Dao이다.

 

실질적으로 여기서 데이터베이스에서 부터 정보를 접근하고, 이를 도와주는 자바의 API가 jdbc Template이다.

 

 

 

🍋 내가 만든 Rest API를 리액트에 연결해보자! 

 

나는 스프링부트 프로젝트를 9000번 포트에서 열었고 , 리액트를 3000번 포트에서 열었다. 이러다 보니 다른 포트에서 자원을 공유하는 상황이 생겨버렸고 역쉬나 CORS 에러를 만나고 말았다.

 

https://meaningland02.tistory.com/44

[Springboot,React] CORS 해결하는 방법

여기에 해결과정을 잘 적어놓았다.

 

유튜브 홈화면을 데모로 구성해보았다. 내가 만든 api가 이렇게 연결되다니 감격스러운 순간이 아닐 수 없다.(?)

 

💙 최종코드는 여기서 확인해보세요 : https://github.com/JjungminLee/YoutubeClone_Project