[TIL] API, HTTP, REST개념 & python으로 사용해보기

API

'Application Programming Interface'의 약자로, 프로그램들이 소통할 수 있는 인터페이스라고 합니다. 

(프로그램들의 소통은 당연히 code로 하겠죠?!) 👩🏻‍💻

---

그렇다면 인터페이스는 뭘까요?!

사전적 의미로는 '어떠한 두 가지의 의사소통을 목적으로 만들어진 물리적, 가상적 매개체'입니다.

굉장히 추상적인 의미이긴 하지만, 저희는 이미 많은 인터페이스들을 사용하고 있습니다!

그중의 하나로 UI(User Interface : 사용자 인터페이스)의 하나인 GUI(Graphic User Interface)가 있습니다.

지난 포스팅에서, CLI와 GUI에 대한 차이에 대해서 이야기했었습니다 :)

직관적으로 UI는 디지털 기기에 명령에 내리는 방법이라고 생각하시면 됩니다! 예를 들어, 저희가 앱을 사용할 때 마주하는 모든 디자인, 기술 등의 전반적인 모든 것들을 포함하는 거죠!

우선 인터페이스에 대한 설명은 여기까지 하고 오늘의 주제인 API로 가봅시다.

 

API

처음 공부하면서 저도 API에 대한 직관적인 이해를 하고 싶어서 많은 자료를 찾아봤는데, 이 말이 딱 와닿았습니다. 

"API는 키보드와 유사하다고 생각하면 쉽다!" - 노마드 코더

키보드의 기능들이 내부적으로 어떻게 작업하는지는 알 수 없지만, 어떠한 버튼을 누르면 결과값을 돌려받을 수 있어요!

요즘 회원가입할 때 카카오로 로그인, 구글로 로그인, 네이버로 로그인 등의 서비스가 굉장히 많죠?

어떤 코드로 해당 API가 이루어지는지는 알 수 없지만, 해당 기능을 이용할 수는 있죠?

---

HTTP와 HTTPS 그리고 REST API

HTTP(HyperText^[각주:1] Transfer Protocol)는 컴퓨터들의 통신 규약(protoco) 중 하나로, 웹에서 사용하는 프로토콜^[각주:2]입니다.

쉽게 말해 컴퓨터들이 통신 간에 사용하는 "형식"이라고 생각하면 쉬습니다.

예를 들어, 아래 이미지는 사람이 아는 형식입니다. 보내는 사람, 이름, 우편번호 등을 적는 형식!

출처 : https://parksunny.tistory.com/165

하지만 컴퓨터는 못 알아듣겠죠? HTTP는 컴퓨터가 알아들을 수 있는 형식! 인 겁니다!

구글 URL

그렇다면 구글 홈페이지 URL 앞에 https는 무엇일까요?

---

HTTPS(HyperText Transfer Protocol Secure)

HTTPS의 S는 Secure 단어 그 뜻 자체로 안전, 보안입니다.

HTTP에서 S, 안전이 추가되어  HTTP protocol의 암호화된 버전으로 생각하시면 되는데요,

민감한 정보를 서버와 안전하게 주고받도록 도와준답니다. 예를 들면 금융 활동이나 온라인 쇼핑!

그리고 여기서 나오는 개념이 바로 암호화! 대칭키, 비대칭키 개념입니다. 해당 개념은 다음 포스팅에 가볍게 다루겠습니다!(예고편)

---

REST API (REpresentational State of Transfer)

REST(REpresentational State)

• HTTP 를 사용할 때 특정 가이드라인들을 제시하는 것
• 즉, REST 아키텍쳐는 HTTP를 사용할 때 일종의 가이드라인을 제시해서 웹 API 의 혼란 속에 질서를 세우려고 하는 것
• HTTP 요청을 보낼 때, 어떤 URI에 어떤 메소드를 사용할지 등에 대한 개발자들 사이에서 널리 지켜지는 약속🤙

REST API

• REST 기반으로 서비스 API를 구현한 것
• 웹에서 사용함(HTTP 가이드라인이기 때문에 당연하겠죠?!)

RESTful API

• REST라는 가이드라인을 모두 지키는 API

제가 이해한 언어로 간단하게 REST에 대해 알아보았습니다! 추가적인 내용은 HTTP 메소드를 직접 사용해 보며 포스팅으로 준비해보겠습니다 :) 메소드를 조금 더 알고 싶은 분께는 하단 reference에 있는 얄코 유튜브 추천드립니다!

---

python으로 API 사용해보기

OpenWeather이라는 사이트에서 진행하겠습니다. 회원가입만 하시면 무료로 API key를 받을 수 있습니다.

아래 사진처럼 회원가입 -> 본인의 닉네임 클릭 -> My API Keys에 들어가시면 default로 이미 주어져있고, 추가로 만들 수도 있습니다!

OpenWeather 사이트

 

사이트에서 API라는 메뉴바를 누르면, 다양한 API를 확인하실 수 있고, 저는 Current Weather Data API를 사용했습니다!

 

API doc click!

 

Current Weather Data API

 

Current Weather Data API를 클릭하면, API call, Parameter 등 다양한 방법이 소개되어 있습니다.

저는 도시의 이름으로 날씨를 가져올 수 있는 'By city name'으로 해보겠습니다.

참고로 Parameters에서 required는 필수로 입력이 되어야 할 값, optional은 선택사항이에요!

홈페이지와 아래 코드에서 확인할 수 있듯이 도시의 이름과 본인의 API key를 입력하면 정보를 받아올 수 있습니다.

(아래 코드에서는 https가 명시가 안 되어있지만, 기본적인 사항이라 생략한 것입니다)

 

api.openweathermap.org/data/2.5/weather?q={city name}&appid={API key}

참고로 아래 이미지처럼 해당 주소를 그대로 브라우저 창에 입력하면 json 형태로 바로 확인도 가능해요!

저는 optional으로 한국어^[각주:3]로 제공하도록 옵션을 추가했어요:)

 

json 파일

 

그러면 이제 파이썬에서 가지고 와볼게요!

import requests
import json

API_URL = "https://api.openweathermap.org/data/2.5/weather?q={city name}&appid={API key}"

response = requests.get(API_URL)
print(response.text)

 

파이썬에서도 잘 가지고 와집니다! 코드를 보시면 아시겠지만 txt 즉, 텍스트 파일로 가지고 왔어요!

 

터미널에서 실행시킨 파이썬

 

해당 txt를 json이나 dictionary로 바꾸는 코드를 소개합니다!

response = requests.get(url)
# print(response.text)
parsed_data = json.loads(response.text) # JSON -> dictionary
to_json = json.dump(parsed_data) # dictionary -> JSON

JSON -> dictionary 또는 dictionary -> JSON 데이터 타입으로 바꿀 때 정말 유용할 것 같아요!

---

저는 해당 API에서 London, Seoul, Sydeny의 날씨만 쏙 뽑오는 코드를 작성해 보았습니다.

cities = [
    "London",
    "Seoul",
    "Sydney"
]

for city in cities:
    city_url = f"https://api.openweathermap.org/data/2.5/weather?q={city}&appid={myAPIkey}&lang=kr"
    response = requests.get(city_url)
    parsed_data = json.loads(response.text)
    print(f"도시 : {city}\t날씨 : ", parsed_data['weather'][0]['description'])

 

cites라는 list를 만들고, for 반복문을 이용하여 뽑아보았습니다.

제 코드에서 {myAPIkey}라고 적힌 부분에는 꼭 자신의 key를 적어주셔야 합니다! :)

 

터미널에서 파이썬을 실행시킨 화면

 

이상 API에 대해 공부하고, 간단한 실습한 내용에 대한 기록입니다:)

다음 포스팅에서 다른 API, 더 심화된 실습을 기록하겠습니다. 읽어주셔서 감사합니다.

 

REFERENCE

• 공식 자료
  • HTTP : https://ko.wikipedia.org/wiki/HTTP
  • HTTPS : https://developer.mozilla.org/ko/docs/Glossary/https
  • HTTP method : https://restfulapi.net/http-methods/
• 유튜브 영상
  • https://www.youtube.com/watch?v=iyFHfzCRHA8
  • https://www.youtube.com/watch?v=iOueE9AXDQQ&t=308s
  • https://www.youtube.com/watch?v=fwpbLEXL3pU
• 이미지 참조
  • https://parksunny.tistory.com/165

1. HyperText는 참조(하이퍼링크)를 통하여 한 문서에서 다른 문서로 즉시 접근할 수 있는 텍스트를 말함. [본문으로]
2. 프로토콜의 종류는 매우 많다. 웹에서 사용하는 HTTP 외에도 이메일과 관련된 작업을 하는 IMAP, SMTP등 다양한 종류가 있습니다. [본문으로]
3. lang=kr [본문으로]