По мере развития вашего программного обеспечения, развивается и ваш API. Спецификации API постоянно обновляются, и ваша документация должна соответствовать. Поскольку страницы с API-документацией являются атоматически сгенерированными, процесс анологичен процессу Обновления автоматически сгенерированных страниц.
- Откройте одну из страниц с API-документацией или родительский узел.
- Нажмите кнопку Обновить. Она находится либо в меню, которое появляется при наведении на дерево страниц, либо на верхней панели редактора страницы.
- Укажите путь к новой версии файла OpenAPI/Swagger или переместите файл с вашего компьютера. Также можно указать URL-адрес файла.
Файл должен быть общедоступным и не защищенным паролем. - Дождитесь пока Документерра обработает файл.
- Нажмите Завершить.
Вот и всё - ваша API-документация теперь актуальна!