Endpoint

Введение: Что такое API

Подробно про API вы можете прочитать в статье «Тестирование API»

Для упрощенного понимания эндпойнтов можно представить, что разработчики софта дли нам инструкции с адресами куда можно отправлять запросы и ограничениями на сами запросы.

Адреса это и есть эндпойнты. В простейшем случае у API может быть один эндпойнт, который поддерживает один HTTP метод. Может быть один эндпойнт, который поддерживает несколько HTTP методов, может быть много разных эндпойтов.

Endpoint

Адрес, на который посылаются сообщения называется Endpoint.

В русскоговороящем сегменте интернета иногда используется термин «Ручка» - сделать запрос к Endpoint - дёрнуть за ручку. Это происходит от сходного по смыслу термина handler.

Где-то с 2023-го года на русскоязычных сайтах стал популярен прямой перевод - «Конечная точка» например «Конечная точка API»

Обычно эндпойнт это IP адрес + порт, либо URL (например, название сайта) и порт.

Если я хочу создать веб сервис на своём сайте с помощью Flask на порту 5000 Endpoint будет выглядеть так:

http://andreyolegovich.ru:5000

А если для своих нужд запущу на локальном хосте Jenkins то эндпойнт у него будет

http://127.0.0.1:8080

Слово адрес нужно понимать в общем смысле - как при отправке бумажного письма нужно написать на конверте физический адрес, так и при обращению к сервису у которого больше одного интерфейса нужно указать нужный.

Разные порты обычно соотвествуют совершенно разным сервисам. Если вы читаете это через браузер, то он обратился к моему сайту по порту 80. Это не видно в URL так как 80 это порт по умолчанию.

Если моему Web сервису нужно будет отвечать на различные сообщения я создам сразу несколько URL (interfaces) по которым к сервису можно будет обратиться.

Например

https://andreyolegovich.ru:5000 /resource1/status
https://andreyolegovich.ru:5000 /resource1/getserviceInfo
https://andreyolegovich.ru:5000 /resource1/putID
http://andreyolegovich.ru:5000 /resource1/eventslist
https://andreyolegovich.ru:5000 /resource2/putID
…

Как видите у моих эндпойнтов (Enpoints) различные окончания. Такое окончание в Endpoint называются Resource, а начало Base URL.

Такое определение Endpoint и Resource используется, например, в SOAP UI для RESTful интерфейсов

https://andreyolegovich.ru:5000 - это Base URL

/resource1/status - это Resource

Endpoint = Base URL + Resource

Понятие Endpoint может использоваться в более широком смысле. Можно сказать, что какой-то определённый роутер или компьютер является Endpoint. Например, в понятии Endpoint Management под Endpoint имеют в виду конечное устройство. Обычно это понятно из контекста.

Также следует обратить внимание на то, что понятие Endpoint выходит за рамки RESTful и может использовать как в SOAP так и в других протоколах.

Термин Resource также связан с RESTful, но в более широком смысле может означать что-то другое.

На программистском сленге Endpoint иногда называют ручкой.

Сделать какой-то запрос, например HTTP, на сленге будет - дёрнуть ручку