Описание API / контракты
Модуль для хранения и группировки методов API, связей с элементами JSON-схем и кодами выхода для стандартизации условий обмена между сервисами и приложениями через API Оставить заявкуРешаемые вопросы
-
Систематизированное хранение описаний методов API
Описание методов API путём заполнения готовой формы с необходимыми параметрами и их хранение в удобной иерархической системе -
Связь методов API с кодами выхода
Объединение метода API с соответствующим кодом выхода, описанным в системе
-
Связь с функциональными возможностями программного обеспечения (ПО)
Объединение приложения (API) с программным обеспечением (ПО) для быстрого получения необходимой информации -
Поиск кодов выхода в реестре
Быстрый поиск кодов выхода в категории с помощью фильтров по наименованию, описанию и другим параметрам
Описание методов API
Создавайте информационные модели приложений (API), содержащие группы методов API. Заполняйте каждый метод (API endpoint) данными в уже готовой форме со всеми необходимыми параметрами. Храните информацию в удобной иерархической системе, позволяющей легко организовывать, группировать и находить нужные методы API.
Связь методов с кодами выхода
При описании метода вы сможете добавить связь с кодом выхода. Это позволит быстро получить доступ к информации о том, какие коды выхода могут возвращать конкретные методы API, и что означают эти коды.
Связанное программное обеспечение (ПО)
Вы можете связать приложение API с программным обеспечением (ПО), описанным в системе. Также каждая функциональная возможность может быть связана с методом API, благодаря чему вы сможете перейти к ней из «Реестра связей» этого метода.
Поиск кодов выхода
Чтобы найти конкретный код выхода, воспользуйтесь поиском по ключевым словам в навигационном дереве элементов. Также все коды будут собраны в таблицу в реестре категории «Коды выхода», где вы сможете отфильтровать их по наименованию, типу, статусу, описанию и другим параметрам.