TalkITАкадемияОглавление

Статья 8.3.1

Контракты API и справочник SDK

Как найти контракт конкретной операции — На примере чтения объекта открыть публичную спецификацию нужного выпуска. Найти идентификатор операции, способ авторизации, адрес, параметры, схему успешного ответа и описанные ошибки. Отдельно показать, где указан режим повтора для команд изменения.
Как сопоставить операцию с методом SDK — По перечню покрытия SDK найти продукт и доступный метод. В справочнике TypeDoc посмотреть типы параметров и результата. Проверить, в какой профиль PAT входит операция и включена ли она в используемую версию пакета.
Как проверить совместимость примера — Зафиксировать версию SDK, соответствующий пакет публичного API и выпуск сервера. На учебном объекте выполнить указанное в статье чтение. При расхождении сравнить контракт и типы целевого выпуска до обновления приложения.