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

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

Управление Live Documentation

Включение Live Documentation

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

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

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

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

Отключение Live Documentation

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

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

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

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

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