Základní anatomie požadavku API

Úvod do API v Pythonu

Chris Ramakers

Engineering Manager

Co jsou URL?

URL = Uniform Resource Locator
Strukturovaná adresa prostředku API
Upravte URL pro interakci s konkrétními prostředky API

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

Rozbor URL

Diagram znázorňující části URL: Protokol (http://), Doména (350.5th-ave.com), Port (:80), Cesta (/unit/243) a Dotaz (?floor=77).

Protokol = způsob přenosu
Doména = adresa kancelářské budovy
Port = brána nebo dveře pro vstup do budovy
Cesta = konkrétní kancelář v budově
Dotaz = doplňující instrukce

Přidávání parametrů dotazu pomocí 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

Argument params slouží k přidání parametrů dotazu

# 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 slovesa

Cíl: Jednotka 243 kancelářské budovy 350 5th Ave
URL: http://350.5th-ave.com/unit/243

Akce

Sloveso	Akce	Popis
GET	Čtení	Zkontrolovat obsah poštovní schránky
POST	Vytvoření	Vložit nový balíček do schránky
PUT	Aktualizace	Nahradit všechny balíčky novým
DELETE	Smazání	Odebrat všechny balíčky ze schránky

¹ HTTP sloves je celkem 9, ale pro jednoduché REST API jsou relevantní pouze tato 4

Odesílání dat pomocí POST a 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ždé sloveso má vlastní metodu v balíčku requests
Argument data slouží k předání dat v požadavku POST nebo PUT.

Pojďme si procvičit!

Úvod do API v Pythonu