Программные интерфейсы

спринт Программные интерфейсы
Компьютерная сеть и протоколы
6/6
О чём этот спринт
Сетевая модель OSI
Сетевая модель TCP/IP
HTTP-запрос
Параметры HTTP-запроса
HTTP-ответ
Стили представления данных
2/2
Postman
2/2
Стили взаимодействия
4/4
Проектирование взаимодействия
1/1
Воркшоп и домашнее задание
1/2
Заключение
1/1

HTTP-ответ

В предыдущих уроках вы узнали, что взаимодействие через HTTP основывается на концепции запрос-ответ. В этом уроке мы подробно разберём, из чего состоят HTTP-ответы и какие они бывают.
Айгуль
Даня, что-то случилось? Почему такой расстроенный?
Даня
Хотел любимый сериал детства на Оtium посмотреть, а его там больше нет.
Айгуль
Наверное, у них блок на просмотр сериалов в рабочее время 😉
Даня
Так у меня обеденный перерыв! Если 404 — это тайное обозначение такого блока, то да 😆
Айгуль
К слову о 404, давай-ка о HTTP-ответе расскажу!

HTTP-ответ

Как вы помните из прошлого урока, взаимодействие через HTTP построено на концепции запрос-ответ. Сервер отправляет клиенту ответ, сообщая, смог ли он выполнить запрос клиента.
клиент посылает серверу запрос, а сервер клиенту — ответ
HTTP-ответ должен включать в себя:
  • Код состояния (Status Code).
  • Заголовки (Headers).
  • Тело (Body).
из чего состоит HTTP-ответ
HTTP-ответ может выглядеть так:
версия протокола: http 1.1, код состояния: 200 OK. заголовки: Content-Type: application/json; charset=utf-8 Date: Fri, 21 Jun 2019 03:38:45 GMT. тело ответа: [{"id": 1, "name": "Scott Hunter"}, {"id": 2, "name": "Scott Hunselman"}, {"id": 3, "name": "Scott Guthrie"}]

Код состояния

Код состояния — это трёхзначное число, которое кратко информирует о результате выполнения запроса.
Код состояния может передать клиенту много ценной информации. Например, вы могли видеть страницу с таким ответом на каком-либо веб-сайте:
страница с ошибкой 404
Код состояния 404 означает, что ресурс не найден (Not Found). Когда клиент запрашивает ресурс, которого не существует, сервер отвечает кодом 404, чтобы дать клиенту понять, что такого ресурса на сервере нет и клиенту нет смысла его запрашивать. После получения ответа от сервера цикл «запрос-ответ» завершается, и сеанс связи закрывается. Сервер больше не будет отправлять клиенту никаких данных до тех пор, пока не получит новый запрос.
Коды, которые пользователи видят в веб-браузере при ошибке, можно объединить в группы по значению, исходя из результата выполнения запроса. Коды всегда состоят из трёх цифр, и по первой можно определить, к какой группе относится ответ:
  • 1хх — предварительный ответ на запрос;
  • 2хх — запрос успешно обработан;
  • 3хх — сообщает, что для успешного выполнения операции необходимо сделать другой запрос;
  • 4хх — ошибки на клиенте (то есть у того, кто выполняет запрос);
  • 5хх — ошибки на сервере (то есть у того, кто выдаёт ответ).
В описании метода указывают, какие коды состояния веб-сервер может вернуть в ответ на запрос. Главная цель клиента при отправке любого запроса — получить от сервера трёхзначный код, который начинается с двойки, то есть код успешной обработки запроса. Если сервер возвращает ответ с кодом, начинающимся с тройки, четвёрки или пятёрки, необходимо либо изменить запрос, либо дождаться, когда ошибка на сервере будет устранена.

1хх

Этот код состояния обозначают предварительный ответ. Клиентский компьютер получит один или несколько ответов 1xx прежде, чем получить обычный ответ.
`100 Continue` Это промежуточный ответ. Информирует о том, что запрос успешно принят, и клиент может продолжать присылать запросы.

2хх

Эти коды состояния указывают на успешное принятие сервером запроса.
`200 OK`: Запрос клиента успешно обработан. Что значит "успешно", зависит от метода, который был запрошен. Например, найден и вернулся запрашиваемый ресурс, или выполнено. `201 Created`: Запрос клиента успешно выполнен, и в результате был создан один или несколько ресурсов.`202 Accepted`: Запрос принят, но ещё не обработан.`203 Non-Authoritative Information`: Запрос выполнен, но предоставленная информация взята не из первоначального источника.

3хх

Эти коды состояний указывают на то, что клиенту необходимо совершить дополнительные действия для выполнения запроса.
`300 Multiple Choices`: Запрос имеет более чем один из возможных ответов. И задача клиента (или пользователя) - выбрать один из ответов.`301 Moved Permanently`: Этот код ответа значит, что место запрашиваемого ресурса было изменено на постоянной основе. Возможно, новое место будет предоставлено в ответе.`302 Moved Temporarily`: Этот код ответа значит, что место запрашиваемого ресурса было изменено временно. Возможно, новое место будет предоставлено в ответе.

4хх

Эти коды состояния указывают на возникновение ошибки на стороне клиента. Например, клиент мог запросить несуществующую страницу.
таблица с кодами ниже в кате
4xx

5хх

Эти коды состояния указывают на то, что сервер не может выполнить запрос, так как столкнулся с ошибкой.
таблица с кодами ниже в кате
5xx
Воспользуйтесь памяткой, чтобы запомнить часто встречающиеся коды ответа.
В качестве примера рассмотрим ответ на запрос к ресурсу предметы-сервировки-стола.рф.
JSX
GET http://предметы-сервировки-стола.рф
User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729)
Accept: text/html
Accept-Language: ru  

-> 401
В ответ приходит код 401, который означает, что пользователь неавторизован, а неавторизованным пользователям выполнять запрос к этому ресурсу запрещено.
Чтобы избавиться от этой ошибки, передадим данные авторизации в заголовке запроса.
JSX
GET http://предметы-сервировки-стола.рф
Authorization: Basic FjgFIKVcGVuc5HgjTk
User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729)
Accept: text/html
Accept-Language: en  

-> 200
Теперь в ответе код 200. Запрос выполнен успешно!
Распределите коды состояния по группам, к которым они относятся.
Запрос успешно обработан
201
200
Ошибки на клиенте
404
408
400
Ошибки на сервере
504
500
Определите, какой код ответа пользователь увидит на странице браузера в каждой из этих ситуаций.
Пользователю отправили ссылку для заказа товара, но при копировании часть ссылки потерялась.
404
Сервер веб-сайта по прослушиванию музыки недоступен, в этот момент пользователь пытается перейти на сайт, чтобы включить музыку.
503
На время технических работ на сервере администратор закрыл доступ пользователей к некоторым страницам.
403

Заголовки

Назначение заголовка ответа схоже с назначением заголовка запроса. Если в запросе веб-браузер через заголовок сообщает серверу, как читать запрос, то в ответе сервер сообщает браузеру, как интерпретировать полученный ответ. Поля заголовка HTTP-ответа помогают клиенту (веб-браузеру) правильно обработать HTTP-сообщение веб-сервера.

Параметры заголовка ответа (Response Header Parameters)

В заголовках ответа используются те же параметры типовых заголовков, что и в запросах, например: Content-Type, Content-Length, Content-Location. В дополнение к типовым заголовкам в ответах используются специализированные заголовки, которые применяются только в ответах на запрос клиента. Вот некоторые из них:
Параметр заголовкаНазначение
StatusСообщает код ответа HTTP
Status: 200
Retry-AfterЗаголовок HTTP ответа показывает, как долго клиент должен подождать перед следующим запросом. Обычно возвращается вместе с кодом ошибки 5xx. Может быть указано конкретное время или задержка в секундах.
Retry-After: Tue, 30 Oct 2022 09:30:00 GMT
Retry-After: 180
LocationURL имеющегося (с кодом 3xx) или вновь созданного (с кодом 201) ресурса, по которому клиент может перейти.
Location: http://предметы-сервировки-стола.рф
AllowСписок поддерживаемых методов
Allow: POST, GET, TRACE, HEAD
ServerСписок названий и версий веб-сервера и его компонентов.
Server: Apache/2.4.54
AgeВозвращает количество секунд, прошедших с момента модификации ресурса.
Age: 154034
DateВозвращает время формирования ответа и позволяет клиенту обновить время у себя.
Date: Sat, 30 Nov 2022 18:15:00 GMT
Last-ModifiedВозвращает время последнего редактирования ресурса и позволяет клиенту проверить актуальность данных в кэше.
Last-Modified: Fri, 30 Dec 2020 14:38:54 GMT
WWW-AuthenticateПараметры аутентификации для осуществления доступа к указанному ресурсу возвращаются обычно с кодом 401.
Например, WWW-Authenticate: Basic означает, что данные пользователя будут переданы закодированными в base64
Так может выглядеть пример заголовка в ответе на запрос к ресурсу предметы-сервировки-стола.рф.
Status: 200 
Content-Type: text/html 
Date: Mon, 24 Jul 2022 16:06:00 GMT
Last-Modified: Mon, 18 Jul 2016 02:36:04 GMT
Server: Apache/1.3.27
В результате запроса был получен код ответа 200 (Status Code), ответ передан в формате html и сформирован 24 июля, 2022 года, а последний раз ресурс обновлялся 18 июля 2016 года, ответ пришёл с сервера Apache версии 1.3.27.

Тело

Если код состояния всего лишь показывает результат обработки запроса (успех или неуспех), то тело ответа содержит данные, которые необходимы клиенту, отправившему запрос.
Как и в случае с запросами, наличие в ответе тела зависит от используемого в запросе метода. Например, у запроса с методом DELETE тело ответа может отсутствовать, так как достаточно кода ответа (ресурс либо удалён, либо нет). Тело ответа будет содержать запросы с методами GET и POST, потому что эти запросы подразумевают получение данных.
В случае с методом GET http://предметы-сервировки-стола.рф/кофейная-пара/чашка мы ожидаем получить все данные, связанные с ресурсом «чашка»: идентификатор, материал, диаметр. Какую информацию мы действительно получим, расскажет именно тело ответа.
Например, для кода ответа 200 тело ответа может быть таким:
JSON
{
    “responseBody”: [
        {
            ”id”: 1,
            “material”: “фарфор”,
            “diameter”: 10},
        {
            ”id”: 2,
            “material”: “стекло”,
            “diameter”: 12}
        ]
}
В теле этого ответа указан список ресурсов «чашка», которые были найдены по запросу. Серверу удалось найти два таких ресурса с разными идентификаторами (id) и характеристиками (material, diameter).
Данное тело ответа описано с использованием стиля представления данных JSON. Ответ может также содержать текст, изображение и другой тип данных. Если бы по запросу не было найдено ресурсов, сервер вернул бы ответ с кодом 400. Тело ответа выглядело бы так:
JSX
 {
    “responseBody”: 
        {
            ”Error”: "По запросу ничего не найдено, проверьте корректность запроса"
    }
}
Перед вами пример HTTP-ответ на метод GET http://товары-для-животных.рф/кошки/корм. Выберите верные утверждения.
JSON
Status: 200 
Content-Type: text/html 
Date: Mon, 16 Jan 2023 10:34:30 GMT
Last-Modified: Mon, 12 Oct 2020 00:58:02 GMT
Server: Apache/1.3.27

{
    “responseBody”: [
        {
            ”id”: 1,
            “category”: “для котят”,
      “country”: “италия”,
            “weight”: 1},
        {
            ”id”: 2,
            “category”: “для беременных кошек”,
      “country”: “германия”,
            “weight”: 7}
    {
            ”id”: 3,
            “category”: “для пожилых кошек”,
      “country”: “россия”,
            “weight”: 2}
        ]
}

Подведём итоги

В ответ на HTTP-запрос сервер отправляет клиенту HTTP-ответ.
HTTP-ответ состоит из:
  • Кода состояния (Status Code).
Код состояния показывает результат обработки запроса. Коды всегда состоят из трёх цифр, по первой можно определить статус ответа (успех или неуспех) и причины ошибки.
  • Заголовков (Headers).
В заголовках сервер сообщает браузеру, как интерпретировать полученный ответ.
  • Тела (Body).
Тело ответа содержит данные, которые необходимы клиенту, отправившему запрос.
Заголовки и тело ответа могут быть написаны с помощью разных стилей представления данных. О них поговорим в следующем уроке.