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

Импорт определений OpenAPI/Swagger

В этом практическом руководстве вы узнаете, как импортировать определения OpenAPI/Swagger в Документерру. 

Система поддерживает только Swagger 2.0, OpenAPI 3.0 и OpenAPI 3.1. 

Шаги

  1. Чтобы вызвать мастер импорта, нажмите кнопку Импортировать документ на странице Проекты или кнопку Импорт в левом нижнем углу редактора страниц.
  2. Выберите опцию OpenAPI на первой странице мастера импорта. Иконка OpenAPI на первой странице мастера импорта
    При импорте со страницы «Проекты» укажите, хотите ли вы создать новый проект или добавить страницы к существующему. Для нового проекта укажите название и язык. 
  3. Нажмите Далее.
  4. Укажите путь к файлу определений OpenAPI/Swagger или перетащите его со своего компьютера. Обратите внимание, что файл должен быть общедоступным и не защищен паролем.
    Можно указать/загрузить только один файл, поэтому, если вам нужно импортировать несколько определений OpenAPI в один проект, запустите мастер несколько раз.
    Мастер импорта OpenAPI, страница 2
  5. Нажмите Далее.
  6. Подождите, пока Документерра обработает файл.
  7. На последней странице мастера импорта нажмите Открыть проект, чтобы открыть проект, или Готово, чтобы выйти из мастера.

Вот и все! Этот быстрый и простой способ позволит вам легко импортировать определения OpenAPI в систему Документерра. Возможно, вы также захотите узнать больше об обновлении импортированных определений.