раздел 04
Как попробовать
Теория ясна - теперь отправим настоящий запрос. Это можно сделать без единой строчки в проекте, прямо из терминала или браузера.
Чем пробовать
curl
Команда в терминале. Есть в macOS и Linux из коробки, в Windows тоже. Быстро и без установки.
Postman / Insomnia
Программы с окошком: вводите URL, заголовки, тело и жмёте Send. Удобно, когда запросов много.
Браузер
Для простых GET без ключа: вставьте адрес в строку и увидите JSON прямо на странице.
Пример через curl
Возьмём открытое API без ключа - GitHub отдаёт данные о пользователе. В терминале:
curl https://api.github.com/users/torvalds
В ответ придёт JSON с публичными данными:
{
"login": "torvalds",
"name": "Linus Torvalds",
"public_repos": 7,
"followers": 230000
}
Чтобы увидеть и код статуса с заголовками, добавьте флаг -i:
curl -i https://api.github.com/users/torvalds
Тот же запрос на Python
В Python для этого есть библиотека requests (ставится командой pip install requests):
import requests
response = requests.get("https://api.github.com/users/torvalds")
print(response.status_code) # 200
data = response.json() # ответ как словарь Python
print(data["name"]) # Linus Torvalds
print(data["public_repos"]) # 7
Логика та же, что в curl: отправили GET, получили ответ, проверили код статуса, прочитали JSON. Метод response.json() превращает текст ответа в обычный объект, с полями которого дальше работаете в коде.
Как читать документацию API
Документация - это меню сервиса. Открывая её, ищите по порядку:
- Базовый URL - общее начало всех адресов, например
https://api.example.com/v1. - Список endpoint-ов - какие «двери» есть и каким методом к ним обращаться.
- Аутентификация - нужен ли ключ и как его прикладывать.
- Параметры и тело - что можно или нужно передать в запросе.
- Примеры ответов - какие поля придут и что они значат.
- Лимиты - сколько запросов разрешено.