Podstawowa anatomia żądania API

Wprowadzenie do API w Pythonie

Chris Ramakers

Engineering Manager

Czym są adresy URL?

URL = Uniform Resource Locator
Ustrukturyzowany adres zasobu API
Dostosuj URL, aby korzystać z konkretnych zasobów API

http://350.5th-ave.com/unit/243

Budowa adresu URL

Diagram przedstawiający części adresu URL: Protokół (http://), Domena (350.5th-ave.com), Port (:80), Ścieżka (/unit/243) i Zapytanie (?floor=77).

Protokół = środek transportu
Domena = adres budynku biurowego
Port = brama lub drzwi wejściowe do budynku
Ścieżka = konkretne biuro w budynku
Zapytanie = dodatkowe instrukcje

Dodawanie parametrów zapytania w requests

# Append the query parameter to the URL string
response = requests.get('http://350.5th-ave.com/unit/243?floor=77&elevator=True')
print(response.url)

http://350.5th-ave.com/unit/243?floor=77&elevator=True

Użyj argumentu params, aby dodać parametry zapytania

# Create dictionary
query_params = {'floor': 77, 'elevator': True}
# Pass the dictionary using the `params` argument
response = requests.get('http://350.5th-ave.com/unit/243', params=query_params)
print(response.url)

http://350.5th-ave.com/unit/243?floor=77&elevator=True

Czasowniki HTTP

Cel: Lokal 243 w budynku biurowym przy 350 5th Ave
URL: http://350.5th-ave.com/unit/243

Akcje

Czasownik	Akcja	Opis
GET	Odczyt	Sprawdź zawartość skrzynki pocztowej
POST	Utwórz	Wrzuć nową paczkę do skrzynki
PUT	Aktualizuj	Zastąp wszystkie paczki nową
DELETE	Usuń	Usuń wszystkie paczki ze skrzynki

¹ Łącznie istnieje 9 czasowników HTTP, ale w prostych REST API istotne są tylko te 4

Wysyłanie danych za pomocą POST i PUT

# GET = Retrieve a resource
response = requests.get('http://350.5th-ave.com/unit/243')

# POST = Create a resource
response = requests.post('http://350.5th-ave.com/unit/243', data={"key": "value"})
# PUT = Update an existing resource
response = requests.put('http://350.5th-ave.com/unit/243', data={"key": "value"})

# DELETE = Remove a resource
response = requests.delete('http://350.5th-ave.com/unit/243')

Każdy czasownik ma własną metodę w pakiecie requests
Użyj argumentu data, aby przekazać dane w żądaniu POST lub PUT.

Czas na ćwiczenia!

Wprowadzenie do API w Pythonie