Разделы документации

Операции и поверхности API

Выберите поверхность API, опишите контракт операции и свяжите его с требованием.

Для кого предназначен API

Поверхность API Surface объединяет операции подсистемы, доступные определённому клиенту или интеграции. При выборе поверхности исходите из того, кто вызывает операцию.

Чтобы добавить поверхность, откройте подсистему в Architecture и выберите Create API Surface на вкладке API. Для этого нужны права на управление архитектурой. В API Operation Types выберите New API Operation Type или Add Existing Types и укажите нужную поверхность.

Контракт операции

  1. В Specifications → API Operations откройте нужную поверхность и нажмите Create API Operation.
  2. Дайте операции название в Name и укажите технический идентификатор в Technical Name. Для HTTP это может быть метод и путь. Задайте расположение Location и доступный тип Type, затем нажмите Create.
  3. Опишите контракт в Description.
Часть контрактаЧто записать
Вызывающая сторонаКто отправляет запрос и какие права нужны.
Входные данныеОбязательные параметры, тело запроса и правила проверки.
Успешный ответФормат ответа и наблюдаемые изменения.
ОшибкиУсловия отказа и ответ, который получит клиент.

Связь с ожидаемым поведением

В нужном требовании выберите Specifications → + → API Operations и добавьте операцию. Перейдите к ней по связи и проверьте, что контракт покрывает условия и результат сценария.

Связаться с нами

Поля, отмеченные *, обязательны для заполнения.

0 / 5 000

Можно также написать на info@reqode.com