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

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

HTTP-запрос

В этом уроке вы познакомитесь ближе с HTTP (HTTPS) — протоколом прикладного уровня сетевой модели TCP/IP, а также изучите его составляющие.
Даня
Кстати, я немного знаю об HTTP!
Айгуль
Конечно, наверняка каждый день в браузере видишь 😜
Даня
Точно! Но я не об этом. Мой путь в мир системного анализа начался именно с HTTP-запроса 😎
Айгуль
Хм, интересно, не терпится услышать эту историю!
Даня
Договорились, но хочется сначала с HTTP разобраться! Я точно не всё знаю и многое уже забыл.

HTTP-протокол

Правила взаимодействия между устройствами в сети Интернет устанавливает протокол прикладного уровня HTTP. Он регулирует правила формирования запроса от веб-браузера (клиента) к веб-серверу (серверу).
HTTP (Hypertext Transfer Protocol) — это основной протокол для обмена данными между компьютерами в сети Интернет. Сочетание из четырёх букв — HTTP — видел каждый, кто выходит в интернет через веб-браузер, ведь именно с названия протокола начинаются адреса веб-сайтов.
Как только вы вводите адрес, который начинается с http://, веб-браузер понимает, что для общения с веб-сервером нужно соблюдать протокол HTTP.
Сейчас гораздо чаще встречаются адреса, которые начинаются с https://. Например, адрес веб-сайта Яндекс Практикума https://practicum.yandex.ru начинается как раз с https.
Протокол передачи гипертекста через SSL (Hypertext Transfer Protocol over Secure Socket Layer — HTTPS) — это «младший брат» HTTP, который серьёзнее относится к вашей безопасности в сети: он шифрует часть передаваемых данных в соответствии с протоколом SSL. Таким образом, злоумышленникам становится гораздо сложнее похитить данные.

HTTP-запрос

Взаимодействие через HTTP основывается на концепции запрос-ответ (Request-Response Cycle). Клиент отправляет на сервер запрос на выполнение определённых действий. Сервер, в свою очередь, отправляет клиенту ответ, сообщая, смог ли сервер выполнить запрос клиента.
клиент и сервер обмениваются запросом и ответом
HTTP-запрос клиента к веб-серверу должен включать:
  • URL.
  • Метод.
  • Заголовки.
  • Тело.
из чего состоит HTTP-запрос
Например, HTTP-запрос клиента к серверу может выглядеть так:
POST /shop Host: yandex-market.ru Accept-language: ru {"name": "Магазин посуды", "inn": "8724163"}
Этот запрос и остальные примеры в уроке написаны с использованием стиля представления данных JSON.

URL

Чтобы клиент мог получить данные, он должен знать, где веб-сервер их хранит. То есть он должен знать адрес ресурса — унифицированный указатель ресурса (Uniform Resource Locator — URL).
URL

Адрес ресурса

Рассмотрим на примере столового этикета, который устанавливает правила сервировки стола. Самое важное в сервировке — правильно расположить посуду и приборы.
Каждому гостю, к примеру, полагается пять вилок: для салата, для рыбы, для мяса, для морепродуктов и десертная вилка. Благодаря правилам сервировки гость знает: вилка, которая расположена справа от тарелки, предназначена для морепродуктов, над тарелкой — для десерта.
сервировка стола
Также веб-браузер знает расположение данных на сервере и может их использовать. Данные, которые хранит веб-сервер, называются ресурсами (Resources). Например, ресурсами могут быть **веб-страницы, изображения, видео.
Веб-страницу, на которой вы сейчас находитесь, хранит веб-сервер Яндекс Практикума. Любой веб-браузер может запросить её у веб-сервера для просмотра. Веб-сайт же состоит из множества веб-страниц.
Веб-сервер хранит ресурсы в виде иерархии. Иерархию можно представить как папку со множеством вложенных папок, в которые также входит множество папок и так далее. Как именно ресурсы будут располагаться на веб-сервере, зависит от решения разработчиков.
Например, так:
сервировка в виде иерархии
Или так:
другой вариант иерархии
Используя иерархию, можно описать место любого предмета. Например, вилки для морепродуктов: стол/справа от тарелки/вилка для морепродуктов или стол/вилка/для морепродуктов.
Место на веб-сервере, где хранится ресурс, и называется URL. Посмотрим на URL с веб-сайта Яндекс Практикума:
Вы уже знаете, что https в начале URL — это сигнал веб-браузеру, что общаться с веб-сервером он должен в соответствии с правилами протокола HTTP (обычно HTTPS приравнивают к HTTP).
После названия протокола следует название веб-сервера — practicum.yandex.ru. Сразу за названием веб-сервера — путь до ресурса на веб-сервере: /systems-analyst или /qa-engineer.
С помощью URL https://practicum.yandex.ru/systems-analyst/ можно описать путь до веб-страницы курса «Системный аналитик», а с помощью URL https://practicum.yandex.ru/qa-engineer/ — до веб-страницы курса «Инженер по тестированию».
Опираясь на предложенную иерархию, выберите только корректные URL, то есть те, что соответствуют данной иерархии.
Предметы для сервировки стола: бокал, чайная пара, кофейная пара. бокал: для воды, для игристого вина, для белого вина, для красного вина, для ликёра или хереса. чайная пара: чашка, блюдце. кофейная пара: чашка, блюдце.
Перед вами иерархия ресурсов Яндекс Маркета. Выберите URL, который ведёт к отзывам на веб-сайте. Но учтите, что нас интересуют вообще все отзывы, независимо от того, какую оценку выставил посетитель веб-сайта.
Яндекс Маркет -> магазины. магазины включают ассортимент, предложения, прайс-листы, отзывы. Отзывы включают: с оценкой 1, с оценкой 2, с оценкой 3, с оценкой 4, с оценкой 5.

Метод

Веб-браузер может по-разному использовать данные, которые хранит веб-сервер: он может отправить веб-серверу запрос на просмотр, замену или удаление ресурса, а может передать веб-серверу новые данные для хранения, то есть попросить веб-сервер создать ресурс.
Действие, которое веб-сервер должен выполнить, чтобы удовлетворить запрос веб-браузера, называется методом (Method). Чтобы получить данные, веб-браузер клиента должен понимать, какие действия над ресурсами может совершать веб-сервер и какие методы HTTP-запроса им соответствуют.

Основные методы HTTP

Основные методы, которые предоставляет HTTP, это:
  • POST — создание ресурса Веб-браузер передаёт на веб-сервер определённый ресурс, который он должен записать у себя определённым образом.
  • GET — чтение ресурса Веб-браузер запрашивает у веб-сервера определённый ресурс и получает его в ответ. Например, когда вы открываете главную страницу веб-сайта Яндекс Практикума, ваш веб-браузер использует метод GET.
  • PUT — замена ресурса Веб-браузер может заменить существующий на веб-сервере ресурс.
  • DELETE — удаление ресурса Веб-браузер может удалить ресурс с веб-сервера.
Перед вами список задач, которые могут выполнять продавец и покупатель на сайте Яндекс Маркета. Сопоставьте задачу и тип метода.
Продавец хочет добавить товар в магазин
POST
Покупатель хочет удалить отзыв о магазине
DELETE
Продавец хочет прочитать отзыв покупателя о магазине
GET
Покупатель хочет отредактировать отзыв о магазине
PUT

Другие методы

POST, DELETE, GET и PUT — основные запросы, которые встречаются чаще всего. В работе системный аналитик может встретить и другие методы:
  • CONNECT — метод для установления тоннеля (двусторонней связи) между клиентом и сервером.
  • HEAD — запрашивает заголовки, идентичные тем, которые будут возвращены при вызове метода GET. Может быть выполнен перед загрузкой большого ресурса для получения данных о ресурсе.
  • OPTION — метод запроса данных о методах, поддерживаемых ресурсом.
  • PATCH — метод выборочного обновления существующего ресурса.
  • TRACE — метод для проверки соединения. Получатель должен отразить полученное сообщение назад клиенту в теле ответа.

Безопасность и идемпотентность методов

Методы обладают характеристиками идемпотентности и безопасности.
Идемпотентность (Idempotence) — это свойство объекта или операции, при котором многократное выполнение операции приводит к одному и тому же результату. Пример идемпотентной операции — умножение на 1.
Если отправить запрос GET http://предметы-сервировки-стола.рф/кофейная-пара/блюдце/2, в ответ получим ресурс — блюдце с идентификатором 2. Если отправить этот запрос повторно, то ответ будет тот же. Это и есть идемпотентность: при выполнении операции результат всегда будет одинаковым.
Если отправить запрос POST на создание нового ресурса «красное блюдце», то каждый раз, когда мы будем вызывать этот метод, на сервере будет создаваться новый ресурс «красное блюдце». И каждый раз в ответе мы будем получать разные блюдца одинакового цвета, но с разными идентификаторами. Таким образом, метод POST не является идемпотентным, так как при выполнении операции результат каждый раз будет разным.
Метод также может быть безопасным или небезопасным.
Безопасный метод — метод, предназначенный для получения информации и не изменяющий состояние сервера.
Например, нужно создать ещё один ресурс — блюдце:
JSX
POST http://предметы-сервировки-стола.рф/кофейная-пара/блюдце/
Body: 
{
“material”: “фарфор",
“diameter”: “15"
}
Этот метод является небезопасным, так как при выполнении запроса на сервере создаётся новый ресурс (состояние сервера изменяется, на нём создается ещё один ресурс).
Ниже представлена таблица с характеристиками и описанием методов.
таблица ниже в кате
Методы и характеристики
МетодДействиеБезопасностьИдемпотентность
POSTсоздание ресурса--
DELETEудаление ресурса-+
GETчтение ресурса++
PUTзамена ресурса-+
CONNECTустановления тоннеля (двусторонней связи)--
HEADзапрос заголовков++
OPTIONSзапрос поддерживаемых ресурсом методов++
PATCHвыборочное обновление ресурса--
TRACEпроверка соединения++

Заголовки

Заголовок (Header) — часть HTTP-запроса, которая содержит техническую информацию, необходимую для формирования запроса или ответа.
В заголовках веб-браузер собирает для веб-сервера техническую информацию, например, о типе устройства (о телефоне, компьютере), о языке пользователя (русском, английском или другом) и прочие важные параметры. Они необходимы для корректного отображения информации клиенту.
Заголовки
Именно из заголовка веб-сервер, например, узнает, что веб-браузер запросил мобильную версию веб-сайта, если вы зашли на платформу Яндекс Практикума с мобильного устройства.
Заголовок может выглядеть так:
JSON
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,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-us,en;q=0.5
Из этого заголовка веб-сервер узнает, что используется браузер Mozilla Firefox на устройстве с операционной системой Windows, а язык пользователя — английский.
Параметры заголовка передаются в паре ключ:значение (Key:Value). Например, User-Agent — это название параметра, передающего данные об устройстве клиента, а данные после двоеточия — конкретное значение параметра в данном запросе (то, какую операционную систему или браузер использует клиент).

Тело

Веб-сервер и веб-браузер передают друг другу данные в теле (Body) HTTP-запроса.
тело
Тело включают только HTTP-запросы с методами POST и PUT — веб-браузер должен передать веб-серверу данные о ресурсах, которые веб-сервер должен создать или изменить. В HTTP-запросах с методами GET и DELETE, то есть в запросах на чтение и удаление ресурсов, тело не добавляется — достаточно адреса запрашиваемого ресурса, метода и заголовков.
Например, в коллекции столовых приборов и посуды нужно создать новый бокал для красного вина. В этом случае запрос будет выглядеть так:
JSON
POST http://предметы-сервировки-стола.рф/бокал/для-красного-вина` 
Body: 
{
“volume”: “140",
“height”: “25",
"material": "стекло" 
}
Тело запроса начинается с ключа Body: и пишется в фигурных скобках{}. Веб-браузер должен оформить данные в теле HTTP-запроса так, чтобы веб-сервер мог их понять. Для этого в теле запроса записываются параметры, о которых вы узнаете в следующем уроке.
Соотнесите название частей HTTP-запросов и задачу, которую они выполняют.
Определяет место хранения ресурса на веб-сервере
URL
Указывает, какое действие должен выполнить веб-сервер.
Метод
Содержит важную для передачи и преобразования данных техническую информацию.
Заголовки
Передаёт данные о ресурсах.
Тело

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

HTTP (Hypertext Transfer Protocol) — это основной протокол для обмена данными между компьютерами в сети Интернет.
Взаимодействие через HTTP основывается на концепции запрос-ответ (Request-Response Cycle). Клиент отправляет на сервер запрос на выполнение определённых действий. Сервер, в свою очередь, отправляет клиенту ответ, сообщая, смог ли сервер выполнить запрос клиента.
HTTP-запрос клиента к веб-серверу должен включать:
  • URL (Uniform Resource Locator) — унифицированный указатель ресурса
    Определяет адрес ресурса на сервере.
  • Метод Указывает серверу на действие, которое он должен выполнить, чтобы удовлетворить запрос клиента. POST, GET, PUT и DELETE — основные методы, которые предоставляет HTTP-протокол.
  • Заголовки Передают серверу техническую информацию о клиенте.
  • Тело Передаёт данные о запрашиваемых ресурсах, а также данные, которые необходимо создать или изменить.
Заголовки и тело запроса должны содержать параметры. Подробнее с ними вы познакомитесь в следующем уроке.