Anatomia de bază a unei cereri API

Introducere în API-uri cu Python

Chris Ramakers

Engineering Manager

Ce sunt URL-urile?

URL = Uniform Resource Locator
Adresa structurată a unei resurse API
Personalizați URL-ul pentru a interacționa cu resurse API specifice

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

Structura unui URL

Diagramă cu componentele unui URL: Protocol (http://), Domeniu (350.5th-ave.com), Port (:80), Cale (/unit/243) și Interogare (?floor=77).

Protocol = mijlocul de transport
Domeniu = adresa clădirii de birouri
Port = poarta sau ușa de intrare în clădire
Cale = biroul specific din interiorul clădirii
Interogare = instrucțiuni suplimentare

Adăugarea parametrilor de interogare cu 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

Utilizați argumentul params pentru a adăuga parametri de interogare

# 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

Verbe HTTP

Destinație: Unitatea 243 din clădirea de birouri 350 5th Ave
URL: http://350.5th-ave.com/unit/243

Acțiuni

Verb	Acțiune	Descriere
GET	Citire	Verificarea conținutului cutiei poștale
POST	Creare	Depunerea unui nou pachet în cutia poștală
PUT	Actualizare	Înlocuirea tuturor pachetelor cu unul nou
DELETE	Ștergere	Eliminarea tuturor pachetelor din cutia poștală

¹ Există 9 verbe HTTP în total, dar pentru API-urile REST simple sunt relevante doar acestea 4

Trimiterea datelor prin 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')

Fiecare verb are propria metodă în pachetul requests
Utilizați argumentul data pentru a transmite date într-o cerere POST sau PUT.

Să exersăm!

Introducere în API-uri cu Python