개발형 코딩테스트 준비를 위한 HTTP프로토콜, REST API with python

 

개발형 코딩 테스트 개념 정리

 

API란 무엇인가?

          -Application Programming Interface

          -프로그램끼리 데이터를 주고 받기 위한 방식

 

데이터를 주고 받는 서로의 규칙을 만들어 놓았다 -> 프로토콜

- 이것은 정하기 나름

- 많이 사용하는것중 하나가HTTP(hyper text transfer protocol)

 

예를 들어서 홈페이지에 url을 입력하면 해당 페이지로 가는데 이것이 http 프로토콜이라고 할 수 있다.

(http 프로토콜 순서도)

1.     내가 보고 싶은 페이지의 url 을 브라우저에서 서버 측으로 보낸다

2.     서버는 브라우저 측으로 응답을 보내준다

3.     브라우저는 서버에서 온 응답을 가지고 시각화 하여서 화면에 나타내어 준다.

 

Python에서 사용 방법

 

1.     requests 라이브러리를 import 한다.

2.     요청을 보내는 방법 -> requests.get(‘해당 url’)으로 요청을 한다

3.     그럼 서버에서 requests.get 함수의 반환값으로 응답을 보내는데 이를 변수에 저장한다.

4.     만일 변수명이 reponse 라면 response.text 로 해당 내용을 확인 가능하다. 

  

 

연습예제를 위한 사이트 참고

[https://jsonplaceholder.typicode.com] 에서 응답을 받아와 볼 것이다.

1)     응답을 받아와서 text로 출력해보아라

2)     받은 응답을 requests.json() 라이브러리 함수를 사용하여 딕셔너리로 바꿔 보아라

3)     가공한 데이터를 가지고 원하는 작업을 해보아라

 

 

만일 웹 요청시 매개변수 전달 방법

 

-       HOST+PATH?Parameter1=value1&Parameter2=value2&……

-       위의 같은 형식으로 보내게 되는데 HOST에 해당하는 값을 host 변수에 저장하고 path에 해당하는 값을 변수에 저장하면 url = host+path가 된다. 이를 통하여서 파라미터들을 requests 라이브러리를 통하여서 접근한다.

 

 

 

4가지 메소드의 의미

-  GET – 이 데이터를 조회하고 싶어요!

-  POST – 정보를 서버로 보낼때!

-  PUT – 수정 할때

-  DELETE – 삭제를 요청 할때 

 

 

 

REST API란?

 

-       REST(Representational State Transfer)는 각 자원(Resource)에 대하여 자원의 상태에 대한 정보를 주고 받는 개발 방식을 말한다.

-       GET, POST, PUT, DELETE 등의 HTTP 메서드는 각각의 역할이 있지만, 각 메서드의 기본 설명을 따르지 않아도 프로그램을 개발 할 수 있다고 하였다. 하지만 저마다 너무 다른 방향으로 개발하면 문제가 되므로 기준이 되는 아키텍처가 필요하다.

-       REST는 서버의 자원을 어떠한 방식으로 접근하도록 해야 하는지를 구체적으로 명시한 것이다.

-       특히 HTTP 프로토콜을 그대로 사용하므로 웹이나 모바일 개발에서 서버와 클라이언트가 통신하기에 적합한 방식이다.

 

 

-       API는 프로그램이 상호작용하기 위한 인터페이스 이다. 서버와 클라이언트는 각각 일종의 프로그램으로 볼 수 있는데, 두 개체가 상호작용을 하려면 이를 연결하는 인터페이ㅡ가 필요하다. 이러한 인터페이스를 API 라고 한다.

-       예를 들어 /boards 경로에 들어가야 게시물 정보가 나오도록 만들 수 있다면 API 명세는 ‘클라이언트가 /boards 라는 경로에 들어 갔을 때 게시물 목록을 준다’라고 미리 명시해 놓는 것이고, API 개발은 실제로 서버의 /boards 경로에 들어 갔을 때, 관련 정보가 나오도록 개발까지 하는 것을 의미한다.

 

-       REST API는 REST 아키텍처를 따르는 API를 의미한다.

 

-       클라이언트 입장에서의 REST API 호출 이란, REST 방식을 따르고 있는 서버에 특정한 요청을 보내서 데이터를 가져오는 것을 말한다.

-       그러면 REST API 를 제공한다고 하면 REST API 호출을 통해서 데이터를 가져와서 프로그램을 개발하면 되겠구나!

 

 

 

이제 REST를 이용하는 방법을 살펴보자.

1.     HTTP URL로 자원을 명시한다

2.     HTTP 메서드(POST, GET, PUT, DELETE)를 통해 해당 자원을 어떻게 처리할 것인지를 명시하면 된다.

 

REST의 구성요소

1.     자원(Resource): URL를 이용하여 표현

2.     행위(Verb): HTTP 메서드를 이용하여 표현

3.     표현(Representation)

 

 

JSON이란?

 

-       데이터를 주고 받는데 사용하는 경량의 데이터 형식

-       REST API를 사용할 때, 데이터의 형식으로는 일반적으로 JSON을 사용한다.

 

JSON 인코딩 방법

-       JSON 인코딩은 파이썬의 기본 자료형(dict)을 JSON 객체로 변환하는 작업을 의미하는데, 파이썬 JSON라이브러리의 json.dump() 메서드를 이용하면 JSON 객체 생성할 수 있다.

 

 

JSON 디코딩 방법

-       JSON 객체를 파이썬 기본 자료형(dict)로 변환하는 작업이며, json.loads() 메서드를 이용한다.

 

인코딩 디코딩이 헷갈린다… 지금까지 나온 모든 형 변환을 정리해보자

 

1)     (Requests로 받아온 응답은 class:requests  ->  딕셔너리(dict))  = 변수명.json()

2)     (딕셔너리(dict) -> JSON 객체)  =  json.dump(변수명)

3)     (JSON 객체 -> 딕셔너리(dict)) = json.load(변수명)

 

 

 

 

 

 

 

dump와 dumps 차이 

-  dumps는 바로 JSON객체로 string 형식으로 인코딩하여 프로그램 내에서 바로 사용이 용이하고, 반면 dump는 두번째 인자가 fp 로 저장하기 위해 open한 file 포인터가 들어간다.

load와 loads 차이

-  load는 open한 파일의 file 포인터로 접근하여 JSON객체를 딕셔너리로 디코딩 하여준다.

 

 

GET 이외의 다른 HTTP 메서드

 

1)     POST

-  Ex) r = requests.post(url, data = {‘key’ : ’value’})

 

2)     PUT

-  Ex) r = requests.put(url, data = {‘key’ : ‘value’})

 

3)     DELETE

-  Ex) r = requests.delete(url)