En API-förfrågans grundläggande uppbyggnad

Introduktion till API:er i Python

Chris Ramakers

Engineering Manager

Vad är URL:er?

URL = Uniform Resource Locator
Den strukturerade adressen till en API-resurs
Anpassa URL:en för att interagera med specifika API-resurser

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

URL:ens olika delar

Ett diagram som visar olika delar av en URL: Protokoll (http://), Domän (350.5th-ave.com), Port (:80), Sökväg (/unit/243) och Fråga (?floor=77).

Protokoll = transportmedlet
Domän = gataadressen till kontorsbyggnaden
Port = porten eller dörren in i byggnaden
Sökväg = det specifika kontoret i byggnaden
Fråga = eventuella tilläggsinstruktioner

Lägg till frågeparametrar med 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

Använd argumentet params för att lägga till frågeparametrar

# 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

HTTP-verb

Destination: Enhet 243 i kontorsbyggnaden på 350 5th Ave
URL: http://350.5th-ave.com/unit/243

Åtgärder

Verb	Åtgärd	Beskrivning
GET	Läs	Kontrollera brevlådans innehåll
POST	Skapa	Lägg ett nytt paket i brevlådan
PUT	Uppdatera	Ersätt alla paket med ett nytt
DELETE	Ta bort	Ta bort alla paket från brevlådan

¹ Det finns totalt 9 HTTP-verb, men för enkla REST-API:er är bara dessa 4 relevanta

Skicka data med POST och 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')

Varje verb har en egen metod i paketet requests
Använd argumentet data för att skicka data i en POST- eller PUT-förfrågan.

Nu kör vi en övning!

Introduktion till API:er i Python