Wprowadzenie do obsługi interfejsów API

Interfejsy API (Application Programming Interfaces) umożliwiają aplikacjom komunikowanie się ze sobą. Biblioteka requests języka Python ułatwia korzystanie z interfejsów API przez wysyłanie żądań HTTP i obsługę odpowiedzi.

W tej lekcji dowiedzą się Państwo, jak używać biblioteki requests do wysyłania żądań do interfejsów API i przetwarzania odpowiedzi.

Instalowanie requests

Aby zainstalować bibliotekę requests, należy użyć w terminalu następującego polecenia:

pip install requests

Po zainstalowaniu biblioteki można zaimportować ją w skryptach języka Python:

# Importing requests
import requests

print("Requests library imported successfully")

Wysyłanie żądania GET

Metoda GET służy do pobierania danych z interfejsu API. Aby wysłać żądanie GET, należy użyć funkcji requests.get():

# Sending a GET request
import requests

response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
print(response.json())  # Outputs the JSON response

Wysyłanie żądania POST

Metoda POST służy do wysyłania danych do interfejsu API. Należy użyć funkcji requests.post():

# Sending a POST request
import requests

payload = {"title": "foo", "body": "bar", "userId": 1}
response = requests.post("https://jsonplaceholder.typicode.com/posts", json=payload)
print(response.json())  # Outputs the response

Obsługa odpowiedzi

Biblioteka requests udostępnia kilka atrybutów służących do obsługi odpowiedzi, takich jak:

• response.status_code: kod stanu HTTP.
• response.json(): dane odpowiedzi w formacie JSON.
• response.text: surowa treść odpowiedzi.

# Handling responses
response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Failed with status code:", response.status_code)

Dodawanie parametrów zapytania

Parametry zapytania można przekazywać do interfejsów API za pomocą argumentu params w żądaniu GET:

# Adding query parameters
params = {"userId": 1}
response = requests.get("https://jsonplaceholder.typicode.com/posts", params=params)
print(response.json())

Dodawanie nagłówków

Nagłówki umożliwiają wysyłanie wraz z żądaniami dodatkowych informacji, takich jak klucze API lub typy treści:

# Adding headers
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get("https://jsonplaceholder.typicode.com/posts", headers=headers)
print(response.status_code)

Obsługa błędów

Biblioteka requests zapewnia wbudowaną obsługę wyjątków związanych z błędami sieciowymi:

# Handling errors
try:
    response = requests.get("https://jsonplaceholder.typicode.com/invalid")
    response.raise_for_status()
except requests.exceptions.HTTPError as err:
    print("HTTP error occurred:", err)
except requests.exceptions.RequestException as err:
    print("Request error occurred:", err)

Typowe błędy podczas pracy z requests

Oto kilka błędów, których należy unikać:

• Brak obsługi błędów HTTP za pomocą response.raise_for_status().
• Umieszczanie w skrypcie wrażliwych informacji, takich jak klucze API, na stałe.
• Pomijanie określenia właściwej metody HTTP (np. GET lub POST).

Czego się nauczyliśmy?

W tej lekcji nauczyli się Państwo:

• Jak zainstalować i zaimportować bibliotekę requests.
• Jak wysyłać żądania GET i POST do interfejsów API.
• Jak obsługiwać odpowiedzi, dodawać parametry zapytania i nagłówki oraz obsługiwać błędy.

Świetnie! Przejdźmy do następnego tematu.