Hlavičky a stavové kódy

Úvod do API v Pythonu

Chris Ramakers

Engineering Manager

Anatomie zprávy požadavku a odpovědi

Příklad zprávy požadavku a odpovědi. Požadavek: GET /users/42 s hlavičkami. Odpověď: 200 OK s tělem JSON obsahujícím informace o uživateli.

Úvod do API v Pythonu

Počáteční řádek

Příklad tří částí zprávy požadavku nebo odpovědi se zvýrazněným počátečním řádkem

  • Server vždy zahrne číselný stavový kód do zprávy odpovědi
Úvod do API v Pythonu

Stavové kódy

Kategorie stavových kódů

  • 1XX: Informační odpovědi
  • 2XX: Úspěšné odpovědi
  • 3XX: Přesměrování
  • 4XX: Chyby klienta
  • 5XX: Chyby serveru

Často používané stavové kódy

  • 200: OK
  • 404: Nenalezeno
  • 500: Interní chyba serveru
1 Úplný seznam stavových kódů naleznete na stránce MDN: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
Úvod do API v Pythonu

Hlavičky

Příklad tří částí zprávy požadavku nebo odpovědi se zvýrazněnými hlavičkami

key1: Value 1
key2: Value 2
Úvod do API v Pythonu

Příklad: Content negotiation s hlavičkami

Příklad tří částí zprávy požadavku nebo odpovědi se zvýrazněnými hlavičkami

  • Klient přidá hlavičku accept: application/json k požadavku
  • Server odpoví hlavičkou content-type: application/json
Úvod do API v Pythonu

Hlavičky s requests

# Adding headers to a request
response = requests.get(
  'https://api.datacamp.com', 
  headers={'accept':'application/json'}
)
# Reading response headers
response.headers['content-type']
'application/json'
response.headers.get('content-type')
'application/json'
Úvod do API v Pythonu

Stavové kódy s requests

# Accessing the status code
response = requests.get('https://api.datacamp.com/users/12')

response.status_code == 200
True
# Looking up status codes using requests.codes
response = requests.get('https://api.datacamp.com/this/is/the/wrong/path')

response.status_code == requests.codes.not_found
True
Úvod do API v Pythonu

Pojďme si procvičit!

Úvod do API v Pythonu

Preparing Video For Download...