REST API

Resource와 Method

appmaster 2021. 3. 11. 16:30

Resource란?

REST API의 resource는 uri를 통해서 표현이 됩니다.

토픽 전체를 식별하고 싶다면, collection을 이용합니다. 또는 여러개의 토픽을 이용하고 싶다면, collection을 이용하면 됩니다. 빨간 글씨를 보면 알 수 있듯이, 복수형을 사용합니다.

 

 

그리고 하나하나를 분석하려면 element를 이용합니다. element가 모이면 collection이 되는 것입니다.

element의 id값을 이용하는것이 일반적입니다. 만약 이름으로 구분할 수 있다면, 단수형으로 사용하기도 합니다. 

 

리소스를 통해서 uri를 표현한다면 아무것도 할 수 없습니다.

 

topic, comments라는 리소스가 있다.

이 예시를 보면, topic, comments라는 두개의 리소스가 있습니다.

 

이곳에서 보면, topicId를 볼 수 있습니다. topicId: 1은 topics의 id가 1인 것을 가리킵니다. 그래서 comments는 topics id1의 2개의 코멘트라는것을 알 수 있습니다.

 

 

Method란?

정보를 가공하는 방법입니다.

 

총 4가지 밖에 없습니다.

C : create    ---> post

R : read      ---> get

U : update  ---> put/ patch

D : delete   ---> delete

 

rest api는 통신규약인 http를 이용하기 때문에 http가 가지고 있는 메소드를 이용합니다. 

 

post는 본래 생성(create)를 위해서 준비된것이었습니다. rest api는 본래의 뜻을 기반으로 잘 사용해야합니다.

update는 까다로운데요, 전체 내용을 변경하는 put과 일부분을 변경하는 patch가 있습니다.

 

 

ajax를 이용하는 patch라는것을 이용해서 rest api를 만드는 방법을 소개하겠습니다.

 

이것은 웹브라우저로 한정된 것이아닌, 웹서버, 모바일웹, 웹브라우저로 웹서버와 통신할때도 사용합니다.

 

 

 

 

 

즉 결론을 알아냈습니다.
rest api는 기계들이 http를 이용해서 통신할때, resource는 uri로 행위는 method로 결과는 응답코드로 확인이 가능하고 반드시 post, get, put, patch, delete는 CRUD의 내용의 원래 뜻을 기반으로 변형되지않고 사용하기에오!