REST API문서 읽는법

CSR에서는 몇 가지 메소드를 이용해 서버와 통신을 한다.

• GET, POST ,DELETE 등등

그러기 떄문에 사용 목적에 따라서 적절한 API를 사용 해야 한다.

REST API는 웹에서 사용되는 모든 자원을 HTTP URI로 표현하고 메서드를 통해 요청과 응답을 정의하는 방식을 말한다.

• 즉 자기 마음대로 만들지 않고 사용목적 및 조건을 맞추어서 작성하는 것을 말한다.

http://3.36.72.17:3000

이런 url을 본적이 있을 것이다.

이러한 url을 root-endpoint 또는 root-URL 이라고 한다.

• 서버가 요청을 수락하는 시작점을 말한다.

일반적ㅇ으로 도메인 주소의 루트(/)를 가르킨다.

https://api.github.com/user

root-URL의 다음으로 오는 것을 경로 라고 한다.
path라고 하며 서버와 통힌할 수 있는 key역할을 한다.

• 나같은 경우에는 spirng과 react도 해보았기 떄문에
• path가 없는 것은 기본 화면 있는 것은 다른 사이트로 이동할떄

라고 이해를 하였다.

• GET, POST, DELETE 등등 메서드마다 요청을 보내는 형식이 살짝씩 다르기 떄문에 숙지하고 사용을 해야 한다.

URL은 정보의 모든 자원을 표시하게 된다.

예를들면 get요청인데 /user/1122/post 의 형태는 적절 하지 않다.

• POST요청으로 /user/1122가 적절하다.

API를 이용하기 위해서는 KEY가 필요하다.

• 가끔 필요가 없는 경우도 있다.

왜냐하면 우리가 다른 사이트의 API를 이용하게 된다면 그 사이트의 서버와 연결을 하게 되고 그러게 되면 서버운용에 돈이 들어간다는 소리가 된다.

누구도 공짜로 남들에게 제공할 의무는 없다.. 그러기 떄문에 대부분 로그인된 사용자에게만 API를 이용할수 있게 권한을 통해서 KEY를 제공하기도 한다.

• 가끔씩은 key가 필요 없는 경우도 있다.
• 정부에서 제공하는 공공데이터가 그 예시이다.

Postman

브라우저를 통해서 GET요청을 할수가 있다.

• 단순히 root-URL을 입력해 주면 된다.

POST요청도 가능하다.

• 콘솔창에서 코드를 입력하면 된다(fetch)

하지만 매번 코드를 작성하는 것은 매우 번거로운 작업이기 떄문에 도구를 이용해야 하고 이 도구가 Postman이다.

• 일종의 API테스트 도구이다.