Документерра: руководство пользователя

Обновление автоматически сгенерированных страниц

Автоматически сгенерированные страницы нельзя редактировать вручную, их можно обновлять одним нажатием кнопки, получая последние изменения из файла определений, например файлов OpenAPI .json или .yaml.

Процесс обновления, который синхронизирует контент авто-страниц с контентом файла определений, можно запустить в проекте несколькими способами со страницы редактора страниц:

  • Кнопка Обновить в верхней части страницы, заменяющая кнопку Редактировать в разделе Авто-страницы.
    Кнопка автоматического обновления страницы в верхней части редактора страниц
  • Кнопка Обновить, входящая в родительский узел для авто-страниц и появляющаяся при наведении курсора мыши на родительский узел.
    Кнопка обновления авто-страницы в меню при наведении курсора в Дереве страниц

Эта процедура почти полностью автоматизирована. Вам просто нужно выбрать Обновить, указать файл или URL-адрес исходного файла (например, файл .json или .yaml с вашим определением OpenAPI), и система Документерра позаботится обо всем остальном! 

Если вы указываете URL-адрес, убедитесь, что файл не защищен паролем и общедоступен; в противном случае Документерра не сможет его получить.

Независимо от способа обновления — путем загрузки файла или указания URL-адреса — Документерра считывает определение из файла и обновляет весь набор авто-страниц в родительском узле.   Кроме того, система Документерра добавляет новую запись в журнал истории версий родительского узла для авто-страниц: имя пользователя, инициировавшего обновление, и временную метку обновления.

После завершения обновления опубликуйте проект повторно, чтобы пользователи могли увидеть изменения.