출근길에 읽은 IT) REST API(로이 필딩,REST,잘못 설계된 URL,developer console)

'퉁퉁코딩'님의 REST API 개념~ 영상을 읽고 정리한 내용입니다. 

 

Roy Thomas Fielding 

HTTP 사양의 주요 저자 중 한명이자 REST 아키텍처 스타일의 창시자인 미국의 컴퓨터 과학자 

 

REST 

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

 

개발자가 개발할 때 시간을 가장 많이 쏟는 부분은? 

1. Editor & Client 

2. API reference -> API 사용 방법이 기술된 문서 

* API reference는 대기업 같은 경우 테크니컬 라이팅 업무를 보는 테크니컬 라이터를 따로 두기도 한다. 

API 문서를 테크니컬 라이터가 따로 작성하는 경우도 있지만, 대부분은 개발자가 작성하고 테크니컬 라이터의 교정을 받는다. 

 

REST API의 구성 요소 

- HTTP Method 

GET, POST, PUT(데이터 전체 수정), PATCH(데이터 일부 수정), DELETE 

- URL 

데이터 접근 

- Representation 

자원의 표현 

 

잘못 설계된 URL 

Endpoint 

https://yts.mx/api/v2/list_movies.json

The Official Home of YIFY Movies Torrent Download - YTS

~/list_movies.jsonp 

~/list_movies.xml 

왜 잘못 설계되었는가? 

REST API의 자원 표현을 위한 설계 규칙은 다음과 같다. 

1. 소문자만 사용 

2. 하이픈(-)은 사용하지 않고 밑줄(_)을 사용 

3. 확장자(json,xml 등)는 표시하지 않는다

 

API 인증을 위한 키를 발급 받아 사용 

 

API 사용을 위한 developer console 활용 

KakaoMap,알라딘,네이버지도, 구글지도 등 다양하다.