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