Podsumowanie

Wprowadzenie do API w Pythonie

Chris Ramakers

Engineering Manager

Podstawy API

Rola API
Rodzaje API
Komponenty URL
Struktura żądań i odpowiedzi
Metody HTTP

API w Pythonie

Pakiet Requests

import requests

Metody HTTP

# Read a resource
requests.get('https://api.my-music.com')
# Create a resource
requests.post('https://api.my-music.com', data={...})
# Update a resource
requests.put('https://api.my-music.com', data={...})
# Delete a resource
requests.delete('https://api.my-music.com')

Parametry URL

query_params = {'artist': 'Deep Purple'}
requests.get('http://api.my-music.com', params=query_params)

Nagłówki

headers = {'accept': 'application/json'}
response = requests.get('http://api.my-music.com', headers=headers)
print(response.headers.get('content-type'))

Kody statusu

response = requests.get('http://api.my-music.com')
print(response.status_code)

Tematy zaawansowane

Uwierzytelnianie

Uwierzytelnianie podstawowe

headers = {'Authorization':'Basic am9obkBleGF...'}

Uwierzytelnianie kluczem/tokenem API

headers = {'Authorization': 'Bearer faaa1c9f4...'}

Dane strukturalne

Pobieranie danych w formacie JSON

requests.get('https://api.my-music.com', headers={'accept': 'application/json'})

Wysyłanie danych w formacie JSON

playlists = [{"Name":"My favorite songs"}, {"Name":"Road Trip"}]
requests.post('https://api.my-music.com/playlists/', json=playlists)

Obsługa błędów

Rodzaje błędów
- Błędy połączenia
- Błędy HTTP
  - 4XX Błędy klienta
  - 5XX Błędy serwera
Obsługa błędów za pomocą kodów statusu
- response.status_code
Obsługa błędów za pomocą wyjątków
- raise_for_error()

import requests
from requests.exceptions import ConnectionError, HTTPError

try:
    response = requests.get("http://api.music-catalog.com/albums") 
    response.raise_for_status()

except ConnectionError as conn_err: 
    print(f'Connection Error! {conn_err}.')

except HTTPError as http_err:
    print(f'HTTP error occurred: {http_err}')

Gratulacje!

Wprowadzenie do API w Pythonie