Django를 배우고 있지만 아직도 API가 뭔지, 그 중에서도 RESTful API가 뭔지 정체를 모르고 있었다.

시간이 부족하지만 일단 내용을 옮겨놓고 공부하면서 살을 붙여야겠다. 안 쓰면 아예 없던 것이 되므로 🙄

0. 배경지식

URI

Uniform Resource Identifier. 해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소. 처음에 url의 오타인 줄 알았다... ^^!

• /login, /news
• finance.naver.com/marketindex/

HTTP Method

HTTP request가 의도하는 action을 정의한것. POST, GET 등등.

Payload

HTTP request에서 보내는 데이터 (body)

API

Application Programming Interface, 응용 프로그래밍 인터페이스. 즉 응용프로그램에서 사용할 수 있도록, 운영 체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있도록 만든 인터페이스를 뜻한다.

현재 웹페이지 개발을 배우고 있으니 웹 API로 한정해 정리해보자면, 웹 API는 웹 애플리케이션 개발에서 다른서비스에 요청을 보내고 응답을 받기 위해 정의된 명세를 말한다. 블로그 API, 지도 API 등 홈페이지 구축이나 개편 시 추가 개발하지 않아도 오픈 API를 가져와 편리하게 사용할 수 있다.

1. REST?

REpresentational State Transfer의 줄임말이다. 웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고 그 리소스에 대한 행위를 HTTP Method로 정의하는 방식. 엄격한 의미의 rest는 자원을 정의하고 자원에 대한 주소를 지정하는 방법 전반을 일컫는다.

즉, 리소스(HTTP URI로 정의된)를 어떻게 한다(HTTP Method + Payload)를 구조적으로 깔끔하게 표현하는것이다. 예를 들어 method의 경우 최근에는 GET, POST만 사용하는 것이 추세이다.

예를 들어 삼성전자 주식 정보를 받기 위한 HTTP 요청:
HTTP GET https://api.trueshort.com/stock/005930

유저의 보유 주식 종목들을 DB에 저장하는 HTTP 요청:

HTTP POST https://api.trueshort.com/user/portfolio

{
    "user_id" : 1,
    "stocks": [ 
        "005930",
        "298730",
        "378900"
    ]
}

1.1 장점

- self-descriptiveness

RESTful API는 그 자체만으로도 API의 목적이 쉽게 이해가 된다. 예를 들어, 위의 HTTP GET https://api.trueshort.com/stock/005930 요청의 경우, 문서나 주석이 없이도 "https://api.trueshort.com 라는 API에서 삼성전자 주식에 관한 정보를 HTTP 요청을 통해 받아오는 구나" 라는 해석이 쉽게 가능하다.

예를 들어, https://api.trueshort.com/kospi/stock/005930 이라는 구조라면, KOSPI에 속해있는 주식(Stock) 중 삼성전자(005930)을 나타내는 것이다.

https://api.shopping.com/books/novel/stephenking 이라는 구조 이라면, 책들중 소설 그리고 소설중 Stephen King의 소설을 나타내는 구조라는 것을 알 수 있다.

1.2 주의할 점

RESTful HTTP API 규칙이다. 아래 내용을 고려해서 url pattern을 만들어야 한다.

/(슬래시)

• 경로 끝에 슬래시를 넣지 않는다.

URI

가독성을 높이기 위해 아래와 같은 컨벤션을 지킨다.

• URI에 _(underscore)는 잘 포함하지않는다.
• 영어 대문자보다 소문자를 쓴다.
• 너무 긴 단어는 잘 사용하지 않는다.
• 명사를 사용한다. (동사는 method로 표현하기 때문에)

network 7계층?

면접 질문, 따로 정리!

브라우저 rendering

django app에도 render가 있는데 무엇일까
백엔드의 API를 통해 json데이터를 받는 방법은 무엇일까
궁금하고 모르는 것은 너무 많은데 내용이 다 너무 깊다보니까 약간 한도 초과 ... 😭