티스토리 뷰

PROGRAMMING

RESTAPI란? 개념 잡기

비용러브 2022. 7. 31. 04:34

기계와 기계가 규격화 된 방식으로 인터넷(웹)을 이용해서 통신할 수 있도록 있는 통신 규칙

HTTP를 이용한다.(https://opentutorials.org/module/3621)

API=> 시스템을 은행 데이터를 돈 클라이언트를 고객 api를 은행원이라 생각하면 된다

REST API->응용프로그램이 시스템에 있는 데이터를 쉽게 사용하기 위해 시스템이 각 데이터에 이름을 붙혀 정리해 놓은것.

 

Rest api의 규칙

1. URI는 정보의 자원을 표현해야한다.

(GET,POST,PUT)DELETE/topics/1

하나하나의 글을 topic이라 부르기로 했다. 이런 데이터들을 Resource라고 한다

Resource를 rest api로 표현하면 resource는 URI를 통해 표현된다.

이때 전체를 식별하고 싶다면 또는 여러개의 topic을 식별하고 싶다면 http://example.com/topics 이러한 URI를 사용하면 된다.

이러한 것을 Collection이라고 한다. *Collection은 복수형을 사용한다.

한건 한건의 데이터를 Element라고 한다. http://example.com/topics/1

 

URI 설계 시 주의할 점

-구분자(/)는 계층 관계를 나타낼 때 사용

-URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

-하이픈(-)은 가독성을 높이는데 사용

-밑줄(_)은 URI에 사용하지 않는다.

-URI 경로에는 소문자가 적합하다.

-파일 확장자는 URI에 포함시키지 않는다.

이때 http://restapi.example.com/members/soccer/345/photo.jpg (X), GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpG

Accept을 사용한다.

 

리소스 간의 관계를 표현하는 방법

/리소스명/리소스 ID/관게가 있는 다른 리소스명

GET : /users/{userid}/likes/devices (사용자가 '좋아하는' 디바이스 목록)

 

HTTP 응답 상태 코드

 

댓글