Представляем новый компонент JoinApiDocs на базе платформы JoinAPI, предназначенной для быстрой разработки и конфигурирования интерфейсов и интеграционных сервисов. Решение автоматизирует подготовку технической документации и связывает её напрямую с фактической конфигурацией проекта.

В основе JoinApiDocs лежит модель проекта в JoinAPI. Компонент анализирует настроенные объекты, их поля, связи, права доступа, триггеры и используемые запросы, после чего формирует по ним структурированный комплект документов в формате Markdown. Это позволяет описанию системы оставаться согласованным с её реальным состоянием: при изменении схемы данных или настроек достаточно заново запустить генерацию.

Сформированные материалы складываются внутри проекта в директорию /docs-api. Для каждого объекта создаётся отдельная папка с автоматическим описанием. К ним можно добавлять собственные файлы: инструкции, пояснения для бизнеса, примеры кода, схемы интеграций. Автоматически созданные документы и пользовательские материалы разделяются по именам файлов, поэтому при повторной генерации обновляется только та часть, которая отвечает за техническое описание, а подготовленные вручную тексты сохраняются.

JoinApiDocs доступен как разработчикам, так и командам, отвечающим за интеграции и сопровождение. Документацию можно сформировать с помощью консольных команд в среде разработки или получить через HTTP‑запрос в виде единого Markdown‑файла по всему проекту либо по выбранным объектам. Это упрощает подготовку пакетов материалов для партнёров и подрядчиков: вместо набора разрозненных документов компания передаёт систематизированное описание в одном формате.

Компонент поддерживает работу с текстовыми файлами, примерами кода и данными. Файлы на основных языках программирования и веб‑технологиях, а также форматы JSON, XML, YAML, SQL автоматически подготавливаются к отображению с указанием языка для корректной подсветки синтаксиса в совместимых системах. Это даёт возможность включать в документацию наглядные примеры и типовые сценарии без дополнительной ручной подготовки.

Для собственников и руководителей цифровых проектов JoinApiDocs решает сразу несколько практических задач: снижает объём ручной работы по поддержанию документации, повышает прозрачность интеграций за счёт единого согласованного описания интерфейсов и прав доступа, упрощает взаимодействие с внешними командами. Компонент уже доступен для проектов на базе JoinAPI и может быть подключён через панель управления, после чего генерация и обновление документации становятся частью регулярного процесса разработки и сопровождения.