REST API
Endpoint, HTTP-методы, параметры URL, JSON и статусы ответов.
Вопросы и объяснения
Здесь собраны пояснения к каждому вопросу. Если хотите проверить себя, сначала пройдите квиз выше.
Что такое API?
API определяет правила, по которым одно приложение может запросить данные или действие у другого приложения.
Что такое endpoint в REST API?
По адресу /api/v1/users клиент может запросить список пользователей, а /api/v1/users/42 указывает на одного пользователя. Путь помогает API понять, с каким ресурсом работать.
Какой HTTP-метод обычно используется для получения данных?
Запрос GET /api/v1/orders/42 читает данные заказа № 42. Повторное получение страницы или заказа не должно менять его содержимое — для изменений используют другие методы.
Какой HTTP-метод обычно используется для создания ресурса?
POST обычно отправляет серверу данные нового ресурса, например нового пользователя или заказа.
Какой HTTP-метод обычно используется для удаления ресурса?
Запрос DELETE /api/v1/orders/42 просит сервер удалить заказ № 42. Путь указывает конкретный ресурс, поэтому запрос не должен удалять всю коллекцию заказов.
В чём разница между PUT и PATCH?
PUT используют для полной замены ресурса, а PATCH — для частичного обновления, например изменения только статуса заказа.
Что такое path parameter?
В маршруте /api/v1/users/:id значение 42 в адресе /api/v1/users/42 подставляется вместо :id. Так сервер понимает, данные какого пользователя запросили.
Что такое query parameter?
Query parameters часто используют для фильтрации, сортировки или пагинации, например ?status=paid.
Где обычно передаются данные при создании ресурса?
При POST-запросе данные нового ресурса обычно находятся в теле запроса.
В каком формате REST API часто передаёт данные?
JSON — распространённый текстовый формат для обмена структурированными данными между клиентом и сервером.
Что обычно означает HTTP-статус 200?
При успешном GET /api/v1/users/42 сервер обычно возвращает 200 OK вместе с данными пользователя. Это статус успеха, но сам по себе он не означает, что новый ресурс был создан — для создания обычно используют 201 Created.
Что обычно означает HTTP-статус 201?
201 Created обычно возвращают после успешного создания ресурса, например нового пользователя или заказа.
Чем отличаются статусы 400, 401, 403 и 404?
Это клиентские ошибки: запрос может быть неверным, пользователь не вошёл в систему, не имеет прав или обращается к несуществующему адресу.
Что означает HTTP-статус 500?
500 Internal Server Error означает, что сервер не смог корректно обработать запрос из-за внутренней проблемы.
Где указан path parameter в запросе GET /api/v1/users/42?
42 находится в пути URL и указывает на конкретного пользователя, поэтому это path parameter.
Где указан query parameter в запросе GET /api/v1/users?status=active
status=active расположено после знака ? и задаёт дополнительное условие запроса, поэтому это query parameter.
Какой URL содержит query parameter?
Query parameters начинаются после знака ?. В этом примере status=paid передаёт фильтр для списка заказов.