Python 3에서 웹 API를 사용하는 방법

소개

API 또는 애플리케이션 프로그램 인터페이스를 통해 개발자는 하나의 앱을 다른 앱과 통합할 수 있습니다. 제한된 방식으로 프로그램의 내부 작업 중 일부를 노출합니다.

API를 사용하여 다른 프로그램에서 정보를 얻거나 일반적으로 웹 브라우저에서 수행하는 작업을 자동화할 수 있습니다. 때로는 API를 사용하여 다른 방법으로는 할 수 없는 작업을 수행할 수 있습니다. Twitter, Facebook, GitHub 및 DigitalOcean을 포함하여 더 친숙한 웹사이트 또는 모바일 앱과 함께 웹 기반 API를 제공하는 웹 속성이 놀라울 정도로 많습니다.

함수에 대한 몇 가지 자습서를 통해 작업한 경우 좋아하는 API를 활용하는 Python 프로그램을 작성할 수 있습니다.

이 가이드에서는 GitHub의 API와 함께 Python을 사용하는 방법을 배웁니다.

이 과정을 마치면 웹 API 전반에 걸쳐 공통적인 개념을 이해하고 다른 서비스에서 API를 시험해 볼 수 있는 단계별 프로세스와 작업 코드 샘플을 갖게 됩니다.

전제 조건

이 가이드를 시작하기 전에 다음이 필요합니다.

Python 3용 로컬 개발 환경. Python 3용 로컬 프로그래밍 환경 설치 및 설정 방법에 따라 필요한 모든 것을 구성할 수 있습니다.
편하게 사용할 수 있는 텍스트 편집기입니다. 아직 즐겨찾기가 없는 경우 구문 강조 표시가 있는 항목을 선택하십시오. 모든 플랫폼을 위한 Atom은 모두 좋은 선택입니다.
DigitalOcean 계정 및 API 키. DigitalOcean API v2 사용 방법의 처음 몇 단락은 이를 수행하는 방법을 보여줍니다.

1단계 — API에 익숙해지기

새 API를 사용하는 첫 번째 단계는 설명서를 찾고 방향을 잡는 것입니다. DigitalOcean API 설명서는 https://developers.linux-console.net/에서 시작합니다. 다른 서비스에 대한 API를 찾으려면 사이트 이름과 "API\를 검색하세요. 모든 서비스가 첫 페이지에서 해당 API를 홍보하는 것은 아닙니다.

일부 서비스에는 API 래퍼가 있습니다. API 래퍼는 선택한 프로그래밍 언어에서 API를 더 쉽게 사용할 수 있도록 시스템에 설치하는 코드입니다. 이 가이드에서는 래퍼가 API의 내부 작업 대부분을 숨기고 API가 수행할 수 있는 모든 작업을 노출하지 않는 경우가 많기 때문에 래퍼를 사용하지 않습니다. 래퍼는 무언가를 빨리 끝내고 싶을 때 유용할 수 있지만 API 자체가 무엇을 할 수 있는지 확실하게 이해하면 래퍼가 목표에 적합한지 판단하는 데 도움이 됩니다.

먼저 https://developers.linux-console.net/documentation/v2/에서 DigitalOcean API 소개를 살펴보고 요청을 보내는 방법과 응답에서 예상되는 내용에 대한 기본만 이해하려고 노력하세요. 이 시점에서 세 가지만 배우려고 합니다.

요청은 어떻게 생겼습니까? 그들은 모두 단지 URL입니까? 자세한 요청은 데이터 형식이 어떻게 되나요? 일반적으로 웹 브라우저에서 사용하는 것과 같은 JSON 또는 쿼리 문자열 매개 변수이지만 일부는 XML 또는 사용자 지정 형식을 사용합니다.
응답은 어떤 형태입니까? API 문서에는 샘플 요청 및 응답이 표시됩니다. JSON, XML 또는 다른 종류의 응답을 받을 예정입니까?
요청 또는 응답 헤더에는 무엇이 들어가나요? 종종 요청 헤더에는 인증 토큰이 포함되고 응답 헤더는 속도 제한에 얼마나 근접했는지와 같은 서비스 사용에 대한 최신 정보를 제공합니다.

DigitalOcean API는 HTTP 메서드(동사라고도 함)를 사용하여 사용자가 기존 정보를 읽으려고 하는지, 새 정보를 만들거나 삭제하려고 하는지 여부를 나타냅니다. 설명서의 이 부분에서는 사용되는 방법과 용도에 대해 설명합니다. 일반적으로 GET 요청은 POST보다 간단하지만 여기서 완료할 때까지는 큰 차이를 느끼지 못할 것입니다.

API 설명서의 다음 섹션에서는 서버가 요청에 응답하는 방법에 대해 설명합니다. 일반적으로 요청은 성공하거나 실패합니다. 실패하는 경우 원인은 요청에 문제가 있거나 서버의 문제입니다. 이 모든 정보는 범주로 구분된 3자리 숫자인 HTTP 상태 코드를 사용하여 전달됩니다.

200 시리즈는 "성공\을 의미합니다. 귀하의 요청이 유효했고 응답이 논리적으로 뒤따르는 것입니다.
400 시리즈는 "잘못된 요청\을 의미합니다. 즉, 요청에 문제가 있어 서버가 원하는 대로 처리하지 못했습니다. HTTP 400 의 일반적인 원인 수준 오류는 잘못된 형식의 요청 및 인증 문제입니다.
500 시리즈는 "서버 오류\를 의미합니다. 귀하의 요청은 괜찮았지만 귀하가 통제할 수 없는 이유로 서버가 지금 귀하에게 좋은 응답을 제공할 수 없었습니다. 이는 다음과 같아야 합니다. 드물지만 가능성을 알고 있어야 코드에서 처리할 수 있습니다.

코드는 어떤 작업을 시도하기 전에 항상 응답에 대한 HTTP 상태 코드를 확인해야 합니다. 이렇게 하지 않으면 불완전한 정보로 문제를 해결하는 데 시간을 낭비하게 됩니다.

이제 요청을 보내는 방법과 응답에서 무엇을 찾아야 하는지에 대한 일반적인 아이디어를 얻었으므로 첫 번째 요청을 보낼 차례입니다.

2단계 - 웹 API에서 정보 얻기

DigitalOcean 계정에는 웹 UI에서 볼 수 없는 일부 관리 정보가 포함되어 있습니다. API는 친숙한 정보에 대한 다른 보기를 제공할 수 있습니다. 이 대체 보기를 보는 것만으로도 API로 수행할 수 있는 작업에 대한 아이디어가 떠오르거나 몰랐던 서비스 및 옵션이 표시될 수 있습니다.

스크립트용 프로젝트를 생성하여 시작하겠습니다. apis라는 프로젝트의 새 디렉토리를 만듭니다.

mkdir apis

그런 다음 이 새 디렉터리로 이동합니다.

cd apis

이 프로젝트에 대한 새 virtualenv를 만듭니다.

python3 -m venv apis

virtualenv를 활성화합니다:

source apis/bin/activate

그런 다음 스크립트에서 HTTP 요청을 만들기 위해 스크립트에서 사용할 요청 라이브러리를 설치합니다.

pip install requests

환경이 구성된 상태에서 do_get_account.py라는 새 Python 파일을 만들고 텍스트 편집기에서 엽니다. JSON 및 HTTP 요청 작업을 위해 라이브러리를 가져와서 이 프로그램을 시작합니다.

import json
import requests

이러한 import 문은 JSON 데이터 형식 및 HTTP 프로토콜로 작업할 수 있도록 하는 Python 코드를 로드합니다. 우리는 HTTP 요청을 보내는 방법이나 유효한 JSON을 구문 분석하고 생성하는 방법에 대한 세부 정보에 관심이 없기 때문에 이러한 라이브러리를 사용하고 있습니다. 우리는 이러한 작업을 수행하는 데 사용하기를 원합니다. 이 튜토리얼의 모든 스크립트는 다음과 같이 시작됩니다.

다음으로 모든 요청에서 동일한 정보를 보유할 일부 변수를 설정하려고 합니다. 이렇게 하면 반복해서 입력할 필요가 없으며 변경 사항이 있는 경우 업데이트할 수 있는 단일 위치가 제공됩니다. 파일에서 import 문 다음에 다음 줄을 추가합니다.

...
api_token = 'your_api_token'
api_url_base = 'https://api.linux-console.net/v2/'

api_token 변수는 DigitalOcean API 토큰을 보유하는 문자열입니다. 예제의 값을 자신의 토큰으로 바꿉니다. api_url_base 변수는 DigitalOcean API의 모든 URL을 시작하는 문자열입니다. 나중에 코드에서 필요에 따라 추가합니다.

다음으로 API 문서에서 설명하는 방식으로 HTTP 요청 헤더를 설정해야 합니다. 파일에 다음 줄을 추가하여 요청 헤더가 포함된 사전을 설정합니다.

...
headers = {'Content-Type': 'application/json',
           'Authorization': 'Bearer {0}'.format(api_token)}

이것은 한 번에 두 개의 헤더를 설정합니다. Content-Type 헤더는 요청 본문에 JSON 형식의 데이터를 기대하도록 서버에 지시합니다. Authorization 헤더에는 토큰이 포함되어야 하므로 문자열을 생성할 때 Python의 문자열 형식 논리를 사용하여 api_token 변수를 문자열에 삽입합니다. 여기에 토큰을 리터럴 문자열로 넣을 수 있었지만 토큰을 분리하면 앞으로 몇 가지 작업이 더 쉬워집니다.

토큰을 교체해야 하는 경우 별도의 변수일 때 이를 수행하는 위치를 쉽게 확인할 수 있습니다.
다른 사람과 코드를 공유하려는 경우 API 토큰을 제거하기가 더 쉽고 친구가 코드를 어디에 두어야 하는지 쉽게 알 수 있습니다.
자체 문서화입니다. API 토큰이 문자열 리터럴로만 사용되는 경우 코드를 읽는 사람이 자신이 보고 있는 내용을 이해하지 못할 수 있습니다.

이제 이러한 설정 세부 정보를 다루었으므로 실제로 요청을 보낼 차례입니다. 귀하의 성향은 요청을 생성하고 전송하는 것일 수 있지만 더 나은 방법이 있습니다. 이 논리를 요청 전송 및 응답 읽기를 처리하는 함수에 넣으면 수행 중인 작업에 대해 좀 더 명확하게 생각해야 합니다. 또한 테스트 및 재사용을 더 간단하게 만드는 코드로 끝납니다. 그것이 우리가 할 일입니다.

이 함수는 생성한 변수를 사용하여 요청을 보내고 Python 사전에 계정 정보를 반환합니다.

이 초기 단계에서 논리를 명확하게 유지하기 위해 아직 자세한 오류 처리를 수행하지 않지만 곧 추가할 예정입니다.

계정 정보를 가져오는 함수를 정의합니다. 항상 기능 이름을 따라 함수 이름을 지정하는 것이 좋습니다. 이 함수는 계정 정보를 가져오므로 get_account_info라고 합니다.

...
def get_account_info():
  
    api_url = '{0}account'.format(api_url_base)

    response = requests.get(api_url, headers=headers)
    
    if response.status_code == 200:
        return json.loads(response.content.decode('utf-8'))
    else:
        return None

헤더에서 사용한 것과 유사한 Python의 문자열 형식 지정 방법을 사용하여 api_url에 대한 값을 작성합니다. 계정을 반환해야 하는 URL https://api.linux-console.net/v2/account를 얻기 위해 account 문자열 앞에 API의 기본 URL을 추가합니다. 정보.

response 변수는 Python requests 모듈에 의해 생성된 개체를 보유합니다. 이 줄은 스크립트 시작 시 정의한 헤더로 만든 URL로 요청을 보내고 API에서 응답을 반환합니다.

다음으로 응답의 HTTP 상태 코드를 살펴봅니다.

성공적인 응답인 200이면 json 모듈의 loads 함수를 사용하여 문자열을 JSON으로 로드합니다. 우리가 로드하는 문자열은 response 객체인 response.content의 내용입니다. .decode(utf-8) 부분은 이 콘텐츠가 DigitalOcean API의 모든 응답과 마찬가지로 UTF-8 문자 집합을 사용하여 인코딩되었음을 Python에 알립니다. json 모듈은 이 함수의 반환 값으로 사용하는 객체를 생성합니다.

응답이 200이 아닌 경우 None을 반환합니다. 이는 이 함수를 호출할 때 확인할 수 있는 Python의 특수 값입니다. . 이 시점에서 우리는 모든 오류를 무시하고 있음을 알 수 있습니다. 이는 "성공\ 논리를 명확하게 유지하기 위한 것입니다. 곧 보다 포괄적인 오류 검사를 추가할 예정입니다.

이제 이 함수를 호출하고 응답이 좋은지 확인하고 API가 반환한 세부 정보를 출력합니다.

...
account_info = get_account_info()

if account_info is not None:
    print("Here's your info: ")
    for k, v in account_info['account'].items():
        print('{0}:{1}'.format(k, v))
    
else:
    print('[!] Request Failed')

account_info = get_account_info()는 account_info 변수를 get_account_info() 호출에서 반환된 값으로 설정합니다. None 또는 계정에 대한 정보 모음이 됩니다.

None이 아니면 모든 Python 사전에 있는 items() 메서드를 사용하여 각 정보를 한 줄에 인쇄합니다.

그렇지 않으면(즉, account_info가 None인 경우) 오류 메시지를 인쇄합니다.

여기서 잠시 멈추겠습니다. 이중 부정이 포함된 이 if 문은 처음에는 어색하게 느껴질 수 있지만 일반적인 Python 관용구입니다. 그 미덕은 성공 시 실행되는 코드를 오류 사례를 처리한 후가 아니라 조건부에 매우 가깝게 유지하는 것입니다.

원하는 경우 다른 방법으로 수행할 수 있으며 실제로 해당 코드를 직접 작성하는 것이 좋은 연습이 될 수 있습니다. if account_info is not None: 대신 if account_info is None:으로 시작하여 나머지가 어떻게 적용되는지 확인할 수 있습니다.

스크립트를 저장하고 사용해 보세요.

python do_get_account.py

출력은 다음과 같습니다.

OutputHere's your info: 
droplet_limit:25
email:sammy@linux-console.net
status:active
floating_ip_limit:3
email_verified:True
uuid:123e4567e89b12d3a456426655440000
status_message:

이제 API에서 데이터를 검색하는 방법을 알게 되었습니다. 다음으로 API를 사용하여 데이터를 변경하는 좀 더 흥미로운 작업으로 넘어갈 것입니다.

3단계 - 서버 정보 수정

읽기 전용 요청으로 연습한 후에는 변경 작업을 시작할 차례입니다. Python과 DigitalOcean API를 사용하여 DigitalOcean 계정에 SSH 키를 추가하여 이를 살펴보겠습니다.

먼저 https://developers.linux-console.net/documentation/v2/#ssh-keys에서 제공되는 SSH 키에 대한 API 설명서를 살펴보세요.

API를 사용하면 계정의 현재 SSH 키를 나열하고 새 키를 추가할 수도 있습니다. SSH 키 목록을 가져오기 위한 요청은 계정 정보를 가져오기 위한 요청과 매우 유사합니다. 그러나 응답은 다릅니다. 계정과 달리 SSH 키를 0개, 1개 또는 여러 개 가질 수 있습니다.

do_ssh_keys.py라는 이 스크립트에 대한 새 파일을 만들고 마지막 파일과 똑같이 시작합니다. JSON 또는 HTTP의 세부 정보에 대해 걱정할 필요가 없도록 json 및 requests 모듈을 가져옵니다. 규약. 그런 다음 DigitalOcean API 토큰을 변수로 추가하고 사전에 요청 헤더를 설정합니다.

import json
import requests


api_token = 'your_api_token'
api_url_base = 'https://api.linux-console.net/v2/'
headers = {'Content-Type': 'application/json',
           'Authorization': 'Bearer {0}'.format(api_token)}

SSH 키를 얻기 위해 생성할 함수는 계정 정보를 얻는 데 사용한 함수와 유사하지만 이번에는 오류를 더 직접적으로 처리할 것입니다.

먼저 API를 호출하고 응답을 response 응답 변수에 저장합니다. api_url은 이전 스크립트와 동일하지 않습니다. 이번에는 https://api.linux-console.net/v2/account/keys를 가리켜야 합니다.

이 코드를 스크립트에 추가하십시오.

...
def get_ssh_keys():
  
    api_url = '{0}account/keys'.format(api_url_base)

    response = requests.get(api_url, headers=headers)

이제 응답에서 HTTP 상태 코드를 확인하여 오류 처리를 추가해 보겠습니다. 200이면 이전과 마찬가지로 응답 내용을 사전으로 반환합니다. 다른 경우 상태 코드 유형과 관련된 유용한 오류 메시지를 인쇄한 다음 None을 반환합니다.

get_ssh_keys 함수에 다음 줄을 추가합니다.

...

    if response.status_code >= 500:
        print('[!] [{0}] Server Error'.format(response.status_code))
        return None
    elif response.status_code == 404:
        print('[!] [{0}] URL not found: [{1}]'.format(response.status_code,api_url))
        return None  
    elif response.status_code == 401:
        print('[!] [{0}] Authentication Failed'.format(response.status_code))
        return None
    elif response.status_code == 400:
        print('[!] [{0}] Bad Request'.format(response.status_code))
        return None
    elif response.status_code >= 300:
        print('[!] [{0}] Unexpected Redirect'.format(response.status_code))
        return None
    elif response.status_code == 200:
        ssh_keys = json.loads(response.content.decode('utf-8'))
        return ssh_keys
    else:
        print('[?] Unexpected Error: [HTTP {0}]: Content: {1}'.format(response.status_code, response.content))
    return None

이 코드는 응답에서 HTTP 상태 코드를 확인하여 6가지 오류 조건을 처리합니다.

500 이상의 코드는 서버에 문제가 있음을 나타냅니다. 이러한 경우는 드물고 요청 문제로 인한 것이 아니므로 상태 코드만 인쇄합니다.
404 코드는 "찾을 수 없음\을 의미하며 URL의 오타로 인한 것일 수 있습니다. 이 오류의 경우 다음을 수행할 수 있도록 상태 코드와 URL을 인쇄합니다. 실패한 이유를 확인하십시오.
401 코드는 인증에 실패했음을 의미합니다. 가장 가능성이 높은 원인은 api_key가 잘못되었거나 누락되었기 때문입니다.
300 범위의 코드는 리디렉션을 나타냅니다. DigitalOcean API는 리디렉션을 사용하지 않으므로 이런 일이 발생해서는 안 되지만 오류를 처리하는 동안 확인하는 것이 나쁠 것은 없습니다. 많은 버그는 프로그래머가 절대 발생해서는 안 된다고 생각한 일로 인해 발생합니다.
200 코드는 요청이 성공적으로 처리되었음을 의미합니다. 이를 위해 아무것도 인쇄하지 않습니다. 이전 스크립트에서 사용한 것과 동일한 구문을 사용하여 ssh 키를 JSON 개체로 반환하기만 하면 됩니다.
응답 코드가 다른 경우 "예기치 않은 오류\로 상태 코드를 인쇄합니다.

그러면 API 호출에서 발생할 가능성이 있는 모든 오류를 처리해야 합니다. 이 시점에서 오류 메시지와 None 개체가 있거나 성공과 0개 이상의 SSH 키를 포함하는 JSON 개체가 있습니다. 다음 단계는 인쇄하는 것입니다.

...

ssh_keys = get_ssh_keys()

if ssh_keys is not None:
    print('Here are your keys: ')
    for key, details in enumerate(ssh_keys['ssh_keys']):
        print('Key {}:'.format(key))
        for k, v in details.items():
            print('  {0}:{1}'.format(k, v))
else:
    print('[!] Request Failed')

응답에는 SSH 키 목록(또는 배열)이 포함되어 있으므로 모든 키를 보기 위해 전체 목록을 반복하려고 합니다. 이를 위해 Python의 enumerate 메서드를 사용합니다. 이는 사전에 사용할 수 있는 items 메서드와 유사하지만 대신 목록과 함께 작동합니다.

우리는 for 루프가 아닌 enumerate를 사용합니다. 주어진 키에 대해 목록에서 얼마나 멀리 있는지 알 수 있기를 원하기 때문입니다.

각 키의 정보는 사전으로 반환되므로 이전 스크립트에서 계정 정보 사전에 사용한 것과 동일한 for k,v in details.items(): 코드를 사용합니다.

이 스크립트를 실행하면 계정에 이미 있는 SSH 키 목록을 얻을 수 있습니다.

python get_ssh_keys.py

출력은 계정에 이미 있는 SSH 키의 수에 따라 다음과 같이 표시됩니다.

OutputHere are your keys: 
Kcy 0:
  id:280518
  name:work
  fingerprint:96:f7:fb:9f:60:9c:9b:f9:a9:95:01:5c:5c:2c:d5:a0
  public_key:ssh-rsa AAAAB5NzaC1yc2cAAAADAQABAAABAQCwgr9Fzc/YTD/V2Ka5I52Rx4I+V2Ka5I52Rx4Ir5LKSCqkQ1Cub+... sammy@work
Kcy 1:
  id:290536
  name:home
  fingerprint:90:1c:0b:ac:fa:b0:25:7c:af:ab:c5:94:a5:91:72:54
  public_key:ssh-rsa AAAAB5NzaC1yc2cAAAABJQAAAQcAtTZPZmV96P9ziwyr5LKSCqkQ1CubarKfK5r7iNx0RNnlJcqRUqWqSt... sammy@home

이제 계정에 SSH 키를 나열할 수 있으므로 여기서 마지막 스크립트는 목록에 새 키를 추가하는 스크립트입니다.

새 SSH 키를 추가하려면 먼저 생성해야 합니다. 이 단계를 더 자세히 알아보려면 SSH 키 설정 방법 자습서를 살펴보십시오.

그러나 우리의 목적을 위해서는 간단한 키만 있으면 됩니다. 이 명령을 실행하여 Linux, BSD 또는 MacOS에서 새 명령을 생성하십시오. 원하는 경우 기존 Droplet에서 이 작업을 수행할 수 있습니다.

ssh-keygen -t rsa

메시지가 표시되면 파일을 입력하여 키를 저장하고 암호를 제공하지 마십시오.

OutputGenerating public/private rsa key pair.
Enter file in which to save the key (/home/sammy/.ssh/id_rsa): /home/sammy/.ssh/sammy 
Created directory '/home/sammy/.ssh'.
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in /home/sammy/.ssh/sammy.
Your public key has been saved in /home/sammy/.ssh/sammy.pub.
...

스크립트에 필요하므로 공개 키 파일이 저장된 위치를 기록해 두십시오.

새 Python 스크립트를 시작하고 이름을 add_ssh_key.py로 지정하고 다른 스크립트와 마찬가지로 시작합니다.


import json
import requests


api_token = 'your_api_token'
api_url_base = 'https://api.linux-console.net/v2/'
headers = {'Content-Type': 'application/json',
           'Authorization': 'Bearer {0}'.format(api_token)}

우리는 요청을 하기 위해 함수를 사용할 것이지만, 이것은 약간 다를 것입니다.

새 SSH 키에 사용할 이름과 로컬 시스템에 있는 키 자체의 파일 이름이라는 두 가지 인수를 허용하는 add_ssh_key라는 함수를 만듭니다. 함수는 파일을 읽고 GET 대신 HTTP POST 요청을 합니다.

...

def add_ssh_key(name, filename):
  
    api_url = '{0}account/keys'.format(api_url_base)
    
    with open(filename, 'r') as f:
        ssh_key = f.readline()

    ssh_key = {'name': name, 'public_key': ssh_key}
    
    response = requests.post(api_url, headers=headers, json=ssh_key)

with open(filename, r) as f: 줄은 파일을 읽기 전용 모드로 열고, 다음 줄은 파일에서 첫 번째(유일한) 줄을 읽어서 < 코드>ssh_key 변수.

다음으로 API가 예상하는 이름과 값으로 ssh_key라는 Python 사전을 만듭니다.

그러나 우리가 요청을 보낼 때 새로운 것이 조금 더 있습니다. GET이 아닌 POST이며 POST 요청 본문에 ssh_key를 보내야 합니다. , JSON으로 인코딩됩니다. requests 모듈은 세부 사항을 처리합니다. requests.post는 POST 메서드를 사용하도록 지시하고 json=ssh_key를 포함하면 ssh_key를 보내도록 지시합니다. JSON으로 인코딩된 요청 본문의 변수입니다.

API에 따르면 응답은 성공 시 200이 아닌 HTTP 201이며 응답 본문에는 방금 추가한 키의 세부 정보가 포함됩니다.

다음 오류 처리 코드를 add_ssh_key 함수에 추가합니다. 이전 스크립트와 비슷하지만 성공하려면 200 대신 201 코드를 찾아야 합니다.

...
    if response.status_code >= 500:
        print('[!] [{0}] Server Error'.format(response.status_code))
        return None
    elif response.status_code == 404:
        print('[!] [{0}] URL not found: [{1}]'.format(response.status_code,api_url))
        return None
    elif response.status_code == 401:
        print('[!] [{0}] Authentication Failed'.format(response.status_code))
        return None
    elif response.status_code >= 400:
        print('[!] [{0}] Bad Request'.format(response.status_code))
        print(ssh_key )
        print(response.content )
        return None
    elif response.status_code >= 300:
        print('[!] [{0}] Unexpected redirect.'.format(response.status_code))
        return None
    elif response.status_code == 201:
        added_key = json.loads(response.content)
        return added_key
    else:
        print('[?] Unexpected Error: [HTTP {0}]: Content: {1}'.format(response.status_code, response.content))
        return None

이 함수는 이전 함수와 마찬가지로 None 또는 응답 내용을 반환하므로 이전과 동일한 접근 방식을 사용하여 결과를 확인합니다.

다음으로 함수를 호출하고 결과를 처리합니다. 새로 생성된 SSH 키의 경로를 두 번째 인수로 전달합니다.

...
add_response = add_ssh_key('tutorial_key', '/home/sammy/.ssh/sammy.pub')

if add_response is not None:
    print('Your key was added: ' )
    for k, v in add_response.items():
        print('  {0}:{1}'.format(k, v))
else:
    print('[!] Request Failed')

이 스크립트를 실행하면 새 키가 추가되었다는 응답을 받게 됩니다.

python add_ssh_key.py

출력은 다음과 같습니다.

OutputYour key was added: 
  ssh_key:{'id': 9458326, 'name': 'tutorial_key', 'fingerprint': '64:76:37:77:c8:c7:26:05:f5:7b:6b:e1:bb:d6:80:da', 'public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCUtY9aizEcVJ65/O5CE6tY8Xodrkkdh9BB0GwEUE7eDKtTh4NAxVjXc8XdzCLKtdMwfSg9xwxSi3axsVWYWBUhiws0YRxxMNTHCBDsLFTJgCFC0JCmSLB5ZEnKl+Wijbqnu2r8k2NoXW5GUxNVwhYztXZkkzEMNT78TgWBjPu2Tp1qKREqLuwOsMIKt4bqozL/1tu6oociNMdLOGUqXNrXCsOIvTylt6ROF3a5UnVPXhgz0qGbQrSHvCEfuKGZ1kw8PtWgeIe7VIHbS2zTuSDCmyj1Nw1yOTHSAqZLpm6gnDo0Lo9OEA7BSFr9W/VURmTVsfE1CNGSb6c6SPx0NpoN sammy@tutorial-test'}

200 대신 HTTP 201을 찾도록 "success\ 조건을 변경하는 것을 잊은 경우 보고된 오류가 표시되지만 키는 계속 추가됩니다. . 오류 처리는 상태 코드가 201이라고 알려줄 것입니다. 성공을 나타내는 200 시리즈의 구성원으로 인식해야 합니다. 다음은 다음의 예입니다. 기본 오류 처리가 문제 해결을 단순화하는 방법.

이 스크립트로 키를 성공적으로 추가했으면 다시 실행하여 이미 존재하는 키를 추가하려고 할 때 어떤 일이 발생하는지 확인하십시오.

API는 HTTP 422 응답을 다시 보내며 스크립트는 "SSH 키가 이미 계정에서 사용 중입니다.\라는 메시지로 변환합니다.

Output[!] [422] Bad Request
{'name': 'tutorial_key', 'public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCUtY9aizEcVJ65/O5CE6tY8Xodrkkdh9BB0GwEUE7eDKtTh4NAxVjXc8XdzCLKtdMwfSg9xwxSi3axsVWYWBUhiws0YRxxMNTHCBDsLFTJgCFC0JCmSLB5ZEnKl+Wijbqnu2r8k2NoXW5GUxNVwhYztXZkkzEMNT78TgWBjPu2Tp1qKREqLuwOsMIKt4bqozL/1tu6oociNMdLOGUqXNrXCsOIvTylt6ROF3a5UnVPXhgz0qGbQrSHvCEfuKGZ1kw8PtWgeIe7VIHbS2zTuSDCmyj1Nw1yOTHSAqZLpm6gnDo0Lo9OEA7BSFr9W/VURmTVsfE1CNGSb6c6SPx0NpoN sammy@tutorial-test'}
b'{"id":"unprocessable_entity","message":"SSH Key is already in use on your account"}'
[!] Request Failed

이제 get_ssh_keys.py 스크립트를 다시 실행하면 새로 추가된 키가 목록에 표시됩니다.

이 두 스크립트를 약간만 수정하면 필요할 때마다 DigitalOcean 계정에 새 SSH 키를 추가하는 빠른 방법이 될 수 있습니다. 이 API의 관련 기능을 사용하면 고유한 키 ID 또는 지문을 사용하여 특정 키의 이름을 바꾸거나 삭제할 수 있습니다.

다른 API를 살펴보고 방금 배운 기술이 어떻게 번역되는지 살펴보겠습니다.

4단계 - 다른 API로 작업하기

GitHub에도 API가 있습니다. DigitalOcean API 사용에 대해 배운 모든 내용은 GitHub API 사용에 직접 적용할 수 있습니다.

DigitalOcean과 동일한 방식으로 GitHub API에 익숙해지십시오. API 설명서를 검색하고 개요 섹션을 훑어보십시오. GitHub API와 DigitalOcean API가 몇 가지 유사점을 공유하고 있음을 바로 알 수 있습니다.

먼저 모든 API URL에 대한 공통 루트인 https://api.github.com/이 있음을 알 수 있습니다. 오류 가능성을 간소화하고 줄이기 위해 코드에서 변수로 사용하는 방법을 알고 있습니다.

GitHub의 API는 DigitalOcean과 마찬가지로 JSON을 요청 및 응답 형식으로 사용하므로 이러한 요청을 만들고 응답을 처리하는 방법을 알 수 있습니다.

응답에는 DigitalOcean과 거의 동일한 이름과 정확히 동일한 값을 사용하여 HTTP 응답 헤더의 속도 제한에 대한 정보가 포함됩니다.

GitHub는 인증을 위해 OAuth를 사용하며 요청 헤더에서 토큰을 보낼 수 있습니다. 해당 토큰의 세부 사항은 약간 다르지만 사용 방식은 DigitalOcean의 API로 수행한 방식과 동일합니다.

약간의 차이점도 있습니다. GitHub는 사용하려는 API의 버전을 나타내는 요청 헤더의 사용을 권장합니다. Python에서 요청에 헤더를 추가하는 방법을 알고 있습니다.

GitHub는 또한 요청에 고유한 User-Agent 문자열을 사용하여 코드가 문제를 일으키는 경우 더 쉽게 찾을 수 있도록 합니다. 헤더로도 이 문제를 처리할 수 있습니다.

GitHub API는 동일한 HTTP 요청 방법을 사용하지만 특정 작업에 대해 PATCH라는 새로운 방법도 사용합니다. GitHub API는 GET을 사용하여 정보를 읽고, POST를 사용하여 새 항목을 추가하고, PATCH를 사용하여 기존 항목을 수정합니다. 이 PATCH 요청은 API 문서에서 주의 깊게 살펴봐야 할 종류의 것입니다.

모든 GitHub API 호출에 인증이 필요한 것은 아닙니다. 예를 들어 액세스 토큰 없이도 사용자의 저장소 목록을 가져올 수 있습니다. 해당 요청을 수행하고 결과를 표시하는 스크립트를 작성해 보겠습니다.

이 스크립트에서 오류 처리를 단순화하고 하나의 명령문만 사용하여 가능한 모든 오류를 처리합니다. 각 종류의 오류를 개별적으로 처리하기 위해 항상 코드가 필요한 것은 아니지만 상황이 항상 예상대로 진행되지는 않는다는 점을 스스로에게 상기시키기 위해서만 오류 조건에 대해 작업을 수행하는 것이 좋습니다.

편집기에서 github_list_repos.py라는 새 파일을 만들고 다음 콘텐츠를 추가합니다. 이는 꽤 친숙해 보일 것입니다.

import json
import requests


api_url_base = 'https://api.github.com/'
headers = {'Content-Type': 'application/json',
           'User-Agent': 'Python Student',
           'Accept': 'application/vnd.github.v3+json'}

가져오기는 우리가 사용했던 것과 동일합니다. api_url_base는 모든 GitHub API가 시작되는 곳입니다.

헤더에는 GitHub가 개요에서 언급하는 선택적 항목 중 두 개와 요청에서 JSON 형식 데이터를 전송한다고 말하는 항목이 포함됩니다.

이것은 작은 스크립트이지만 로직을 모듈식으로 유지하고 요청을 만드는 로직을 캡슐화하기 위해 여전히 함수를 정의할 것입니다. 작은 스크립트가 큰 스크립트로 커지는 경우가 많으므로 부지런히 작업하는 것이 좋습니다. 사용자 이름을 인수로 받는 get_repos라는 함수를 추가합니다.


...
def get_repos(username):

    api_url = '{}orgs/{}/repos'.format(api_url_base, username)

    response = requests.get(api_url, headers=headers)

    if response.status_code == 200:
        return (response.content)
    else:
        print('[!] HTTP {0} calling [{1}]'.format(response.status_code, api_url))
        return None

함수 내에서 api_url_base, 관심 있는 사용자 이름, GitHub에 저장소 목록을 원한다고 알리는 URL의 정적 부분에서 URL을 빌드합니다. 그런 다음 응답의 HTTP 상태 코드를 확인하여 200(성공)인지 확인합니다. 성공하면 응답 내용을 반환합니다. 그렇지 않은 경우 실제 상태 코드와 우리가 만든 URL을 인쇄하여 어디에서 잘못되었는지 알 수 있습니다.

이제 함수를 호출하고 사용하려는 GitHub 사용자 이름을 전달합니다. 이 예제에서는 octokit을 사용합니다. 그런 다음 결과를 화면에 인쇄합니다.


...
repo_list = get_repos('octokit')

if repo_list is not None:
    print(repo_list)
else:
    print('No Repo List Found')

파일을 저장하고 스크립트를 실행하여 지정한 사용자의 리포지토리를 확인합니다.

python github_list_repos.py

이 예제에서 응답을 JSON으로 구문 분석하지 않았거나 결과를 특정 키로 필터링하지 않았기 때문에 출력에 많은 데이터가 표시됩니다. 그렇게 하려면 다른 스크립트에서 배운 것을 사용하세요. 얻은 결과를 보고 리포지토리 이름을 인쇄할 수 있는지 확인합니다.

이 GitHub API의 좋은 점은 웹 브라우저에서 직접 인증이 필요하지 않은 요청에 액세스할 수 있다는 것입니다. 이를 통해 스크립트에서 보고 있는 것과 응답을 비교할 수 있습니다. 응답을 보려면 브라우저에서 https://api.github.com/orgs/octokit/repos를 방문하십시오.

이제 설명서를 읽고 GitHub API를 사용하여 자신의 목표를 지원하기 위해 보다 구체적인 요청을 보내는 데 필요한 코드를 작성하는 방법을 알게 되었습니다.

GitHub의 이 리포지토리에서 이 자습서의 모든 예제에 대해 완성된 코드를 찾을 수 있습니다.

결론

이 자습서에서는 스타일이 약간 다른 두 가지 서비스에 웹 API를 사용하는 방법을 배웠습니다. 오류 처리 코드를 포함하여 디버깅을 더 쉽게 하고 스크립트를 더 강력하게 만드는 것의 중요성을 확인했습니다. Python 모듈 requests 및 json을 사용하여 이러한 기술의 세부 정보로부터 격리하고 작업을 완료했으며 요청 및 응답 처리를 함수에 캡슐화하여 다음을 수행했습니다. 스크립트를 더 모듈화하십시오.

또한 새로운 웹 API를 학습할 때 따라야 할 반복 가능한 프로세스가 있습니다.

문서를 찾고 소개를 읽어 API와 상호작용하는 방법의 기본 사항을 이해하세요.
필요한 경우 인증 토큰을 받고 간단한 요청을 보내고 오류에 응답하고 응답을 처리하는 기본 오류 처리가 포함된 모듈식 스크립트를 작성합니다.
서비스에서 원하는 정보를 얻을 수 있는 요청을 만듭니다.

이제 이 새로 얻은 지식을 강화하고 사용할 다른 API 또는 여기에서 사용한 API 중 하나의 또 다른 기능을 찾으십시오. 자신의 프로젝트는 여기에서 배운 내용을 강화하는 데 도움이 될 것입니다.