REST API

REST란 📄?

---

"자원"을 이름으로 구분하고 "자원"의 상태를 주고 받는 것이다. "소프트웨어"에서는 자원이 "그림,데이터,동영상"이 될 수 있고 상태를 주고 받는다는 것은 "자원(그림,데이터,동영상)"을 조회,수정,삭제,생성을 할 수 있다는 뜻이다.

REST API 🛸?

---

API에서의 표현은 아래와 같다

용어	내용
자원	자원을 이름으로 구분한다. ex) board/1는 1번 게시물이라는 뜻
행위	HTTP METHOD를 통해서 행위를 한다. ex)GET,PUT,POST,DELETE
표현	다양한 형태로 데이터를 주고 받을 수 있다. ex)JSON,XML,RSS

REST API 설계원칙 🐱‍🏍

---

1.URI는 리소스를 표현해야 한다.

리소스 즉 자원을 표현해야 한다. 리소스는 동사보다는 명사를 사용하는게 적합하다.
아래 예시는 직접 잘못해서 적은것을 경험담으로 적었다.

 # BAD
 /image-crud-d/:SEQ
 
 # GOOD
 /image/:SEQ

위의 BAD 에서는 동사가 들어가 있다. "/image-crud-d/:SEQ"는 동사를 나타낸다. 그래서 "/image/:SEQ"
으로 바꾸었다. 참고로 :SEQ는 게시물 번호이다.

2.리소스에 대한 행위는 HTTP METHOD를 사용한다.

HTTP요청 메소드	목적	예시	페이로드(전송되는 데이터)
GET	정보를 조회 할때 쓰인다.	/image/1	X
POST	정보를 생성할때 쓰인다.	/image/1	O
PUT	정보를 수정 할때 쓰인다.	/image/1	O
DELETE	정보를 삭제 할때 쓰인다.	/image/1	0

HTTP 응답 상태 코드 🥩

---

잘 설계된 REST API는 리소스에 대한 응답을 잘 내어주는것 까지 포함된다고 한다.

상태코드
200	클라이언트의 요청을 정상적으로 수행함
201	클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

---

상태코드
400	클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
403	유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드
405	클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

---

상태코드
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
500	서버에 문제가 있을 경우 사용하는 응답 코드