Базова будова запиту до API

Вступ до API в Python

Chris Ramakers

Engineering Manager

Що таке URL?

URL = Uniform Resource Locator
Структурована адреса до ресурсу API
Налаштуйте URL, щоб працювати з потрібними ресурсами API

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

Розбираємо URL

Схема з частинами URL: Protocol (http://), Domain (350.5th-ave.com), Port (:80), Path (/unit/243) і Query (?floor=77).

Protocol = спосіб передавання даних
Domain = «адреса» офісної будівлі
Port = ворота або двері для входу
Path = конкретний офіс усередині будівлі
Query = додаткові інструкції

Додавання параметрів запиту з requests

# Додайте параметри запиту до рядка URL
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

Використайте аргумент params, щоб додати параметри запиту

# Створіть словник
query_params = {'floor': 77, 'elevator': True}
# Передайте словник через аргумент `params`
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-дієслова

Місце призначення: офіс Unit 243 у 350 5th Ave
URL: http://350.5th-ave.com/unit/243

Дії

Verb	Дія	Опис
GET	Read	Перевірити вміст поштової скриньки
POST	Create	Покласти нову посилку в скриньку
PUT	Update	Замінити всі посилки новою
DELETE	Delete	Забрати всі посилки зі скриньки

¹ Існує загалом 9 HTTP-дієслів, але для простих REST API зазвичай достатньо цих 4

Надсилання даних через POST і PUT

# GET = Отримати ресурс
response = requests.get('http://350.5th-ave.com/unit/243')

# POST = Створити ресурс
response = requests.post('http://350.5th-ave.com/unit/243', data={"key": "value"})
# PUT = Оновити наявний ресурс
response = requests.put('http://350.5th-ave.com/unit/243', data={"key": "value"})

# DELETE = Видалити ресурс
response = requests.delete('http://350.5th-ave.com/unit/243')

Для кожного дієслова є свій метод у пакеті requests
Використайте аргумент data, щоб передати дані в запит POST або PUT.

Давайте потренуємось!

Вступ до API в Python