카테고리 없음

REST API란 ?

박세류 2021. 5. 10. 17:28

1. API ?

API란 Application Programming Interface 으로써 응용 프로그램간에 데이터를 주고받는 방법을 말한다.

 

프로젝트를 진행하면 JSON 혹은 XML 형식으로 값을 return 받을 일이 많다.

 

2. REST ?

Representational State Transfer API 로써 

웹에서 필요한 자원에 접근할 때 웹의 장점을 최대한 활용하기 위한 아키텍처

즉, 개발자들 사이에서 널리지켜지는 약속이다.

잘 짜여진 REST API 를 사용한다면, 주소와 메소드만 보고도 어떤 식으로 API가 이루어져 있는지 

쉽게 파악 할 수 있는 장점이 있어, 현재 많이 쓰인다.

 

2-1 .REST API 구성요소

 

  • HTTP Method 
    • GET - 데이터를 조회하는데 사용된다 (Read)
    • POST - 새로운 데이터를 추가하는데 사용된다 (Create)
    • PUT - 데이터 전체를 수정할때 사용된다.
    • PATCH - 데이터 일부를 수정할때 사용된다.
    • DELETE - 데이터를 삭제할때 사용된다.

        즉, 회원가입등 새로운 데이터를 추가하는 API를 작성할떄는 POST 방식으로, 

        회원의 주문내역등을 조회하는 기능의 API는 GET 방식으로 작성하면 되겠다.

 

  • URL - 데이터에 접근할 수 있는 고유 주소
    • 좋은 URL 설계를 위한 규칙
      1. 소문자만 사용한다
      2. 밑줄_은 사용하지 않고 필요시 하이픈 - 을 사용하되 이것도 지양하여야 한다.
      3. 확장자(.json / .xml ) 등을 표시하지 않는다.
      4. 슬래시는 계층을 구분하는데 사용하므로 마지막에 슬래시 / 를 포함하지 않는다.
      5. 행위는 포함하지 않는다. (URL 에 GET, POST등의 행위를 표현하는게 아닌 Method에 담아 행위를 전달한다.)
      6. 가급적 명사단어를 사용한다.
  • Representation - 자원의 표현
    • URL 만으로도 어떤 자원의 제공되는지 알아야 하는게 잘 설계된 Rest API라 할수 있다.

3.  그렇다면 RESTful API란 ?

REST 하게 작성된 API를 말한다.

 

용어만 보고서는 이해가 잘 되지 않았는데

차근차근 하나씩 보며 공부해 나가니 이해가 되는 느낌이다.

공부한 내용을 적어놓은 것이므로

지적은 감사히 받겠습니다.

 

728x90