Варианты отображения API документации

С февраля 2025 года, в системе Документерра изменился режим отображения API-документации. Новые клиенты автоматически будут использовать новый вариант, без возможности изменения этой конфигурации. Однако клиенты, у которых портал был создан до февраля 2025 года, могут выбирать между двумя вариантами отображения своей API-документации: Классический и Современный.

Варианты отображения

При выборе варианта отображения учитывайте преимущества каждого из них.

Современный
  • Современный и визуально привлекательный пользовательский интерфейс.
  • Расширенная функциональность "Test request", включая выбор сервера для тестирования запросов API.
  • Автоматическая генерация примеров кода для вызовов API.
  • Легкая настройка с использованием читаемых CSS-классов для брендинга и стилизации.

Современный режим отображения API документации
Классический
  • Надежный и привычный интерфейс для API-документации.

Классический вид API документации

Выбор варианта отображения

Клиенты, у которых портал был создан до февраля 2025 года, могут выбрать вариант отображения API-документации в двух местах: при импорте нового файла OpenAPI/Swagger и при обновлении существующих автоматически сгенерированных страниц.

Во время импорта

  1. Запустите процесс импорта.
  2. На шаге 2 мастера выберите Современный или Классический в разделе Режим рендеринга (отображения).
    Выбор режима рендеринга в мастере импорта.

Импортированная API-документация будет отображаться в соответствии с выбранным вариантом.

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

  1. Запустите процесс обновления автоматически сгенерированных страниц, используя один из двух вариантов, описанных здесь: Обновление автоматически сгенерированных страниц. 
  2. В диалоговом окне выберите Современный или Классический в разделе Режим рендеринга.Выбор режима рендеринга во время обновления страниц
Если вы решите перейти на Современный вариант, то будущие импорты и обновления будут использовать новый режим отображения. Однако существующая API-документация останется без изменений.