January 26, 2023

API протоколы и категории.

Оглавление

API - это протокол(механизм) взаимодействия систем или приложений.
Этакая большая функция, основа которой закрыта капотом, но при помощи переменных мы может получить какой-то результат.

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

API (Application programming interface) — это контракт, который предоставляет программа. «Ко мне можно обращаться так и так, я обязуюсь делать то и это».

Контракт включает в себя:

  • саму операцию, которую мы можем выполнить,
  • данные, которые поступают на вход,
  • данные, которые оказываются на выходе (контент данных или сообщение об ошибке).
Проще говоря, это набор компонентов, с помощью которых компьютерная программа (бот или же сайт) может использовать другую программу.

Как вызывается API

  1. Система вызывает функции внутри себя
  2. Система вызывает метод другой системы
  3. Человек вызывает метод
  4. Автотесты дергают методы

SOAP (Simple Object Access Protocol) — стандартный протокол версии W3C, который структурирован и весь задокументирован;

Простыми словами SOAP (или Simple Object Access Protocol) – это простой протокол доступа к объектам, в котором не только вызов процедур, но и передача БД происходит в формате XML.

SOAP — это протокол, по которому веб-сервисы взаимодействуют друг с другом или с клиентами. SOAP API — это веб-сервис, использующий протокол SOAP для обмена сообщениями между серверами и клиентами. При этом сообщения должны быть написаны на языке XML в соответствии со строгими стандартами, иначе сервер вернет ошибку.

REST (Representational State Transfer) — это архитектурный стиль, основанный на методах HTTP

Representational State Transfer — примечание — это архитектурный стиль, а не протоколом. Простыми словами REST — это набор правил и условий для программиста. Если специалист придерживается этим условиям, настройка обмена данными его проекта с другими сервисами будет быстрой и безболезненной.

А оба этих протокола - это веб-службы или сервисы веб-интеграции.SOAP — это формат протокола, основанный на XML, тогда как REST — это архитектурный подход (может передавать как XML, так и JSON)

Чтобы сделать правильный запрос, клиент должен указать четыре вещи:

  1. URL (Unified Resource Locator, единый указатель ресурсов)
  2. Метод (Method)
  3. Список Заголовков (Headers)
  4. Тело (Body)

В REST используются 4 основных HTTP метода:
GET, POST, PUT, delete.
В большинстве случаев каждый из методов служит для выполнения предопределённого ему действия из CRUD (c reate, r ead, u pdate, d elete — «создание, чтение, обновление, удаление»). POST — create, GET — read, PUT — update, delete — delete.


https://systems.education/api-2-protocols
https://www.wrike.com/ru/blog/chto-takoe-programmnyj-interfejs-prilozhenij-api/

Описание API в Confluence

Оглавление