Сервис проектирования API и архитектурного контроля

• проектирование API приложений в концепции API First и их публикации в едином реестре:
  • предоставление инструмента проектирования API-спецификаций в формате OpenAPI Specification 3.0 (OAS 3.0);
  • поддержка шагов создания, согласования и публикации спецификаций OAS 3.0 в едином реестре;
• предоставление средств контроля интеграционных взаимодействий на этапе проектирования за счет:
  • инструмент ведения плановых межкомпонентных взаимодействий (связей);
  • инструмент по разметке архитектурным статусом межкомпонентных связей;
  • инструмент обратного проектирования, выявляющего фактические связи из кода приложений-потребителей API, реализованных в виде интерфейсов Java;
  • инструмент конфигурирования списков контроля доступа (ACL) к API с последующей их передачей в конвейер DevOps для применения изменений правил доступа;
• предоставление информации о наборе API, входящих в состав Платформы;
• ведение единого репозитория информации о наборе API, входящих в состав компонент и бизнес-областей, предоставление информации о наборе API, входящих в состав Платформы за счет:
  • структуры хранения API в привязке к определенному компоненту;
  • структуры хранения компонент с учетом их принадлежности к определенной функциональной области;
  • функционала маркировки компонент признаком принадлежности к платформе;
• управление этапом архитектурного контроля API;
• контроль качества API-спецификаций, размещенных в едином реестре, на предмет соответствия архитектурным требованиям и управление этапом архитектурного контроля за счет:
  • функционала обратной связи о качестве API со стороны команд разработки;
  • функционала автоматической мультикритериальной оценки качества спецификаций API, выявленных в Java-коде, методами обратного проектирования;
  • функционала разметки API архитектурным статусом;
  • функционала массовой разметки API архитектурным статусом;
  • функционала формирования отчета по методам API в разрезе их архитектурных статусов;
• поддержка версионирования API за счет:
  • загрузки и хранения API в разрезе версий, согласно правилам семантического версионирования semver;
  • отображения версий в агрегации по MAJOR.MINOR-номерам semver;
  • возможность выбора и просмотра определенной загруженной версии спецификации API;
• управление нефункциональными требованиями к API с помощью инструмента описания нефункциональных требований (НФТ) в разрезе каждого метода API с возможностью наследования НФТ от API и компонента;
• поддержка принципа обратного проектирования (формирование метаинформации API по исходному коду объекта):
  • предоставление инструмента обратного проектирования (plugin) для включения в жизненный цикл сборщиков maven, gradle, обеспечивающего выявление и последующую публикацию в едином реестре спецификаций API, определенных:
    • Java-интерфейсами, размеченными аннотацией API- библиотек;
    • Java-интерфейсами, размеченными аннотациями jsonrpc4j;
    • OpenAPI спецификациями (OAS 3.0) в формате yaml, включенных в сборки кода;
  • генерация и ведение реестра интеграционных заглушек API для ускорения разработки приложений и повышения качества кода за счет раннего тестирования интеграционных взаимодействий за счет:
    • функционала создания проектной области для работы с эмуляциями;
    • функционала создания эмуляции работы REST API, с возможностью задания описаний значений для заголовков, cookies, кодов ответа, метода и содержимого ответа;
    • инструмента создания эмуляций с сохранением состояния между обращениями к ним;
    • возможности просмотра истории вызовов эмуляций;
    • функционала работы с эмуляциями (публикация и потребление) в едином публичном реестре.

Отчетность

Работа с отчетами

1. Авторизуйтесь в системе.
2. Перейдите в раздел "Отчеты".
3. На открывшейся странице заполните параметры формирования отчета.
4. Нажмите кнопку "Сформировать" для формирования отчета или кнопку "Очистить фильтр" для очистки выбранных параметров. Сформированный отчет сохранится на локальном диске в папке "Загрузки".

Сводный отчет по методам

Детальный отчет по методам

Отчет по НФТ

Свойства классов моделей данных, разрешенные к отправке в ФД

Показатели назначения

• таймаут на формирование HTTP-запроса со стороны клиента после установления соединения (параметр timeout http-request) — 120 секунд;
• таймаут на установление соединения с сервером Gitlab — 10 секунд;
• таймаут на ожидание ответа от сервера Gitlab (параметр timeout server) — 3 минуты;
• максимальное количество соединений (параметр maxconn, определяет максимально возможное количество соединений со стороны Потребителей, суммарный показатель по всем сервисам Works) — не более 50 000. Может уменьшаться в зависимости от ресурсов, потребляемых соединениями со стороны Потребителя.