[TIL]54. API

키워드 : API, RESTful API

API(Application Programming Interface)

프로그램들이 서로 소통할 수 있는 인터페이스

프로그램을 다룰 수 있는 조작 방법 혹은 메뉴얼

• 음식점에 들어간다.
• 메뉴를 보고 주문을 한다.
• 주방에 주문 내용을 전달한다.
• 주문된 음식을 만든다.
• 완성된 음식을 손님에게 드린다.

클라이언트 : 음식점에서 뭔가를 요청하는 '손님'
메뉴판 : API(사전에 약속된 규칙들과 절차)
(API)서버 : 웨이터(음식을 주문하면 음식을 전달해주는 역할)
(Service)서버 : 요리사(실질적으로 요청을 처리하는 역할)

메뉴판은 단지 문서인 것처럼 API 역시 실체가 없다.
음식을 받아야 그 음식의 실제 내용을 확인할 수 있듯이, API 역시 결과 혹은 Return Value 를 받아야 실체를 확인할 수 있습니다.

또, 손님이 햄버거를 주문했는데 피클을 빼달라고 요청을 하게 되면 웨이터가 직접 피클을 빼주지 않습니다. 주방에서 요리를 제작할 때 이러한 부분을 처리하게 됩니다. 이처럼 결국에는 클라이언트의 요청을 서버에서 응답해야 합니다.

API 예시 : 오픈 API, 공공데이터 API, 구글/카카오 API 등 (정확히는 전부 WEB API)
또한, Python의 pandas, scikitlearn 등 도 API로 볼 수 있습니다.

API를 통해 데이터를 받아왔을 때 데이터의 형식은 무엇일까?

정해진 형식은 없으나, 보통 접하게 될 수 있는 응답은 대부부분 JSON 형식

JSON(JavaScript Object Notation)

• 자바스크립트에서 'Object'를 표기하는 방식
• 파이썬의 'Dictionary'와 굉장히 유사합니다.
• 파이썬의 Dictionary처럼 키(Key)와 값(Value)로 묶여져 있는 구조

JSON의 예시

{
  "glossary":{
    "title":"example glossary",
    "GlossDiv":{
      "title":"S",
      "GlossList":{
        "GlossEntry":{
          "ID":"SGML",
          "SortAs":"SGML",
          "GlossTerm":"Standard Generalized Markup Language",
          "Acronym":"SGML",
          "Abbrev":"ISO 8879:1986",
          "GlossDef":{
            "para":"A meta-markup language, used to create markup languages such as DocBook.",
            "GlossSeeAlso":[
              "GML",
              "XML"
            ]
          },
          "GlossSee":"markup"
        }
      }
    }
  }
}

HTTP(HyperText Transfer Protocol ; 하이퍼텍스트 통신 규약) API

하나의 컴퓨터가 다른 컴퓨터와 소통을 하고 싶을 때(파일을 받거나, 전달하거나 등) 정해진 규칙과 틀을 준수해야 원활한 소통이 가능합니다.
이렇게 정해진 규칙들을 하나의 규약(Protocol)이라고 합니다.

이 때, HTTP는 '웹에서 통신할 때 사용되는 규약' 입니다.
HTTP는 크게 요청(Request) 과 응답(Response) 으로 나뉘어져 있습니다.

HTTP Request(요청)

요청하는 컴퓨터가 클라이언트, 요청을 받는 컴퓨터가 서버가 됩니다.

CRUD(CREATE, READ, UPDATE, DELETE)

HTTP 메소드의 경우,

• POST(CREATE) : 서버 측의 특정 리소스를 저장할 때 사용 ex) 회원가입할 때 특정 유저의 정보를 서버에 저장
• GET(READ) : 특정 리소스를 달라고 할 때 사용 ex) 페이지 로딩할 때
• PUT/PATCH(UPDATE) : 서버 측의 특정 리소르를 업데이트할 때 사용, PUT-데이터 전부 변경할 때, PATCH-부분적으로 변경할 때
  ex) 사용자닉네임 변경
• DELETE(DELETE) : 서버 측의 특정 리소스를 삭제할 때 ex) 유저 탈퇴

API를 제작할 때에는 보통 REST 가이드라인을 따르게 되고 이 때 HTTP 메소드들이 사용됩니다.

현재는 이러한 REST 구조를 대부분 따르고 있어 알고 있으면 편합니다.

기본적인 API를 이해하기 위해 CRUD에 해당하는 위의 4개는 알고 있어야 합니다.

HTTP Response(반응)

HTTP 규약을 통해서 보낸 요청에 대한 반응 또한 규약에 따른 응답으로 돌아옵니다.
STATUS CODE

• 100 번대 : 정보 응답
• 200 번대 : 성공 응답
• 300 번대 : 리다이렉션 메시지(다른 방법을 제시하는 메시지)
• 400 번대 : 클라이언트 에러 응답
• 500 번대 : 서버 에러 응답

HTTP 예시

웹 페이지를 열어서 개발자 도구를 연 뒤에 네트워크 탭으로 들어가면 실제로 보내지는 HTTP 요청과 응답을 볼 수 있습니다.

• 'Request Method': 이전에 봤던 HTTP 요청 메소드 중 GET, 리소스를 가져온다는 뜻인 메소드를 사용하고 있습니다.
• 'Status Code' : 200 이라는 숫자 앞에 초록색 불이 들어왔습니다. 200 은 'OK', 성공했다는 뜻입니다. 여기에서는 GET 요청이 성공적이었다는 뜻이 됩니다.
• 'Request URL' : 누가 요청을 하고 있는지를 담고 있습니다.
• 'Remote Address' : 어느 리모트 서버에 요청을 하고 있는지 알려주고 있습니다. 현재는 157.245.183.96 의 443 포트에 요청을 보내고 있습니다.
• 'Referrer Policy' : 요청을 보내는 곳이 당사자인지, 타 웹사이트에서 연결된 건지 등 알려줍니다. 현재는 'no-referrer' 로 현 웹사이트에서 보내고 있습니다.

REST(REpresentational State of Transfer) API

소프트웨어의 아키텍쳐를 어떻게 형성할지에 대한 가이드라인으로 총 6개가 존재하며 다 따르게 된다면 해당 아키텍쳐를 RESTful 이라 합니다.

마찬가지로 WEB API가 REST의 가이드라인들을 다 따르면 RESTful API 라고 부를 수 있습니다.
REST라는 것은 하나의 가이드라인이고 이를 따르기 시작하면 REST API이며 6개의 모든 가이드라인을 지키면 RESTful API라고 할 수 있습니다.

기획자 : "개발자님, API 개발할 때, REST 기반으로 만들어주세요"
개발자 : "개발에 필요한 시간이 부족하고 필요를 못느껴서, RESTful한 API 로 만들지 않아도 될까요?"
기획자 : "네, 좋습니다 REST 가이드라인에 맞게 API를 호출할 수 있도록 개발해주세요"

HTTP API도 사람들이 지키지 않자 한 박사가 좀더 엄격한 규정을 만든 것이 REST API 입니다.

REST API 활용 예시(1)-REQUEST-GET )

GET 요청은 REST 에서 정보나 리소스를 가지고 올 때만 사용하라고 제시됩니다.(즉, 서버에 기록된 데이터나 리소스를 변경할 때 사용해서는 안된다는 뜻)

1. HTTP GET http://www.appdomain.com/users
2. HTTP GET http://www.appdomain.com/users?size=20&page=5
3. HTTP GET http://www.appdomain.com/users/123
4. HTTP GET http://www.appdomain.com/users/123/address

1번 같은 경우에는 /users 로 끝나고 서버에 기록된 유저들을 가져올 거라고 예상할 수 있습니다.
2번 같은 경우에는 마찬가지로 유저를 가지고 오지만 추가 쿼리 파라미터 (? 뒤에 오는 항목들)를 통해 페이지와 개수를 정해주고 있습니다.
3번 같은 경우에는 유저를 가지고 오지만 유저 목록 중에서 123 에 일치하는 유저를 가지고 올 거라는 예상을 할 수 있습니다.
4번 같은 경우에는 3번의 유저 정보에서 address 정보만 가지고 올 거라는 예상을 할 수 있습니다.

REST API 활용 예시(2)-RESPONSE

200 (OK)
201 (Created)
202 (Accepted)
204 (No Content)
301 (Moved Permanently)

추가)

openweather API 예시

import requests
import json

API_URL = 'https://api.openweathermap.org/data/2.5/weather?q=Seoul&appid=3b8fb7eea967548d8cb2837639e4ca9e'

raw_data = requests.get(API_URL)

parsed_data = json.loads(raw_data.text)

print(parsed_data)

json.loads()는 raw_data의 str 형태를 파이썬의 dictionary 형태로 바꿔주는 역할을 합니다.

• JavaScript : JSON, True와 False 가 소문자로 표현, 쌍따옴표만 사용
• Python : Dictionary

json.loads() : 파이썬의 Dictionary 형태로 바꿔줍니다.
json.dumps() : loads 와는 거꾸로 JavaScript의 json 형태(파이썬에서의 형식은 str형)으로 바꿔줍니다.