From f6ab2304b3ee435132afbacae75866f8fd350742 Mon Sep 17 00:00:00 2001 From: parinovK Date: Mon, 15 Jul 2024 00:45:19 +0300 Subject: [PATCH] =?UTF-8?q?=D0=BD=D1=83=D0=B6=D0=BD=D0=BE=20=D0=B7=D0=B0?= =?UTF-8?q?=D0=BF=D0=BE=D0=BB=D0=BD=D0=B8=D1=82=D1=8C=20=D0=BF=D0=B0=D1=80?= =?UTF-8?q?=D0=B0=D0=BC=D0=B5=D1=82=D1=80=20=D0=B4=D0=BB=D1=8F=20=D1=81?= =?UTF-8?q?=D0=BB=D1=83=D0=B6=D0=B5=D0=B1=D0=BD=D0=BE=D0=B3=D0=BE=20=D0=B7?= =?UTF-8?q?=D0=B0=D0=B3=D0=BE=D0=BB=D0=BE=D0=B2=D0=BA=D0=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ru/personal-domain-ya-cloud.md | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/ru/personal-domain-ya-cloud.md b/ru/personal-domain-ya-cloud.md index 850df34..459d61f 100644 --- a/ru/personal-domain-ya-cloud.md +++ b/ru/personal-domain-ya-cloud.md @@ -60,11 +60,17 @@ 1. В поле **Сеть** выберите `default` или свой вариант. -1. Заполните поле **Спецификация**: используйте свою OpenAPI спецификацию или пример ниже, заменив необходимые параметры. +1. Заполните поле **Спецификация**: используйте свою OpenAPI спецификацию или пример. - {% cut "Пример спецификации OpenAPI" %} + {% cut "Пример OpenAPI спецификации" %} - #### Спецификация OpenAPI + {% note warning %} + + Вы открыли пример OpenAPI спецификации. Используйте его, но измените некоторые важные параметры, такие как: адрес внешнего домена или путь, на который должна проксироваться документация. + + {% endnote %} + + #### OpenAPI Спецификация ``` openapi: 3.0.0 @@ -95,26 +101,28 @@ type: string ``` - #### Описание параметров спецификации OpenAPI + #### Описание параметров OpenAPI спецификации #| || Параметр | Описание параметра || - || `servers` | Раздел содержит следующие вложенные параметры: + || `servers` | Настройка вложенных параметров `url` раздела `servers` позволит указать, по какому адресу необходимо проксировать документацию. + Заполните параметры по инструкции: + - Первый `url` параметр содержит адрес, на котором работает API Gateway, — оставьте значение по умолчанию. - - Для второго `url` параметра укажите свой домен. || - || `paths` | Содержит вложенное правило, которое позволяет с помощью параметров конфигурировать ответ на корень урла. Вложенный в раздел `paths`, параметр `/путь/{path+}:` указывает по какому адресу должна располагаться документация. + - Для второго `url` параметра укажите внешний домен, на который нужно проксировать документацию. || + || `paths` | Содержит вложенное правило, которое позволяет с помощью параметров конфигурировать ответ для параметра `url` из раздела `servers`. Параметр `/путь/{path+}:`, вложенный в раздел `paths`, указывает по какому пути должна располагаться документация. {% note info %} - Если вы используете пример OpenAPI спецификации, то документация будет разсположена по адресу `example-for-your-domain.net/docs`. + Если вы используете пример OpenAPI спецификации, то документация будет разсположена по пути `example-for-your-domain.net/docs`. {% endnote %}|| || `get` | Вложенное правило, которое обрабатывает все get-запросы. || - || `headers` | Параметр содержит служебные заголовки: - - x-real-host — домен - - x-docs-proxy-base: docs — в каком каталоге размещаться - - x-docs-project-name: diplodoc-platform--docs — - || + || `headers` | Параметр содержит служебные заголовки. Настройте служебные заголовки для своего домена: + + 1. Для параметра `x-real-host:` укажите адрес внешнего домена. + 1. Для параметра `x-docs-proxy-base:` — укажите в каком каталоге нужно размещать документацию. + 1. Для параметра `x-docs-project-name: ` — укажите .... || || `url` | Параметр, вложенный в правило `get`, содержит адрес, на который перенаправляется документация. {% note info %}