[혼공JS] API와 RESTAPI

RESTAPI, RESTful한 개발 등등 도대체 RESTAPI가 뭔지 몰라 찾아보고 간단하게 정리하고자 합니다.

-AWS 학습페이지 참조

https://aws.amazon.com/ko/what-is/restful-api/

API란?

애플리케이션 프로그래밍 인터페이스(API)는 다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙을 말한다.

 

즉 백엔드 서버와 클라이언트 간에 통신으로 데이터를 주고 받기위한 개발자가 설정한 규칙을 말하는거 같다!

(오류 있을수 있습니다. 반박시 여러분의 말이 맞습니다.)

 

RESTAPI

REST 설계 규칙을 따르는 API를 REST API 를 뜻한다.

 

GET : 리소스 조회. GET 메서드는 데이터를 가져올때만 사용

PUT :  요청 데이터를 사용하여 새로운 리소스를 생성하거나, 대상 리소스를 나타내는 데이터를 수정

POST : 서버로 데이터를 전송한다. 새로운 리소스를 생성(등록)할 때 주로 사용

DELETE :리소스 삭제

 

 

REST API 설계 규칙

1. URI는 정보의 자원을 표현해야 한다.
   resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
   resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
   resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
   resource의 스토어 이름으로는 복수 명사를 사용해야 한다.ex) GET /Member/1 -> GET /members/1
   
   
   
2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
   URI에 HTTP Method가 들어가면 안된다.
   ex) GET /members/delete/1 -> DELETE /members/1
   
   URI에 행위에 대한 동사 표현이 들어가면 안된다.
   (즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
   ex) GET /members/show/1 -> GET /members/1ex) GET /members/insert/2 -> POST /members/2
   
   경로 부분 중 변하는 부분은 유일한 값으로 대체한다.
   (즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
   ex) student를 생성하는 route: POST /students
   ex) id=12인 student를 삭제하는 route: DELETE /students/12
   
   
3. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
   ex) http://restapi.example.com/houses/apartments 
   
   
4. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
   URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 
   역으로 리소스가 다르면 URI도 달라져야 한다.
   REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
   ex) http://restapi.example.com/houses/apartments/ (X)
   
   
5. 하이픈(- )은 URI 가독성을 높이는데 사용
   불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
   
   
6. 밑줄(_ )은 URI에 사용하지 않는다.
   밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
   
   
7. URI 경로에는 소문자가 적합하다.
   URI 경로에 대문자 사용은 피하도록 한다.
   RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
   
   
8. 파일확장자는 URI에 포함하지 않는다.
   REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
   Accept header를 사용한다.
   ex) http://restapi.example.com/members/soccer/345/photo.jpg(X)
   ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
   
   
9. 리소스 간에는 연관 관계가 있는 경우/리소스명/리소스 ID/
   관계가 있는 다른 리소스명
   ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

 

백엔드 서버를 만들어갈때 참조하여 RESTful한 API를 만들어가야겠다.