ПОМОГЛА ЛИ ВАМ ЭТА СТРАНИЦА?

Если вы обнаружили какую-либо проблему на этой странице или с ее содержанием — будь то опечатка, пропущенный шаг или техническая ошибка, сообщите нам об этом!

Управление живой документацией

Последнее обновление: 20.10.2026

Включение интерактивной документации

Чтобы поделиться документацией API с людьми, которые не входят в вашу команду, вам необходимо включить функциональность Live Documentation.

Пока она не включена, она доступна только для предварительного просмотра пользователям, имеющим доступ к определению API.

Перейдите на страницу Настройки своего API, нажав Изменить > Открыть настройки API.
Переведите кнопку Включено из положения Выкл. в положение Вкл. и введите URL-адрес.
Выберите видимость. Если вы выберете Защищено паролем, введите пароль в соответствующее поле.
Нажмите Сохранить, чтобы включить интерактивную документацию.

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

Отключение интерактивной документации

Отключите документацию и выберите, хотите ли вы сохранить ее поддомен.

Откройте свой API и перейдите в Настройки Open API.
Переключите кнопку Включено из положения Вкл. в положение Выкл..
Если вы хотите освободить поддомен документации, необходимо очистить флажок Сохранить активный поддомен документации API.
По умолчанию API Contracts сохраняет поддомен, который вы указали при включении Live Documentation. Это позволяет сохранить тот же URL-адрес, если вы снова включите его позже. Если вы хотите использовать этот поддомен для другого API, сначала необходимо его освободить.
Нажмите Сохранить.

Ваша динамическая документация отключена. Если вы сохранили поддомен, вы можете снова включить его в любое время. В противном случае этот поддомен может быть использован другим API, и вам потребуется ввести поддомен, если вы захотите снова включить эту документацию.

Помогла ли вам эта страница?

Оставьте свой отзыв здесь