Расширение x-yc-apigateway-integration:dummy
Статья создана
Обновлена 10 июля 2024 г.
Расширение x-yc-apigateway-integration:dummy возвращает фиксированное содержимое с указанным кодом ответа и необходимыми заголовками без участия стороннего сервиса.
Добавить расширение в спецификацию можно с помощью конструктора спецификаций.
Поддерживаемые параметры
В таблице ниже перечислены параметры, специфичные для API-шлюза сервиса API Gateway. Описание остальных параметров читайте в спецификации OpenAPI 3.0.
| Параметр | Тип | Описание |
|---|---|---|
http_code |
int |
Код HTTP-ответа. |
http_headers |
map[string](string|[]string) |
Список заголовков, которые будут отправлены в ответ. В http_headers осуществляется подстановка параметров. |
content |
map[string]string |
Данные, которые будут отправлены в ответ. Могут быть как фактическим содержимым, так и отображением из запрошенного Content-Type в данные. Это позволяет отдавать ошибки в запрошенном формате — JSON или XML. Для значения по умолчанию используется ключ *. В content осуществляется подстановка параметров. |
Спецификация расширения
Пример спецификации:
x-yc-apigateway-integration:
type: dummy
http_code: 302
http_headers:
Location: "/some/location"
Set-Cookie: ["a={number}", "b=2"]
content:
"application/json": "{ \"message\": \"You've been redirected.\" }"
Особенности расширения:
- Если в запросе есть заголовок
Accept:- Сначала выбирается лучшее соответствие.
- Если соответствия нет, то выбирается ключ
*. - Если ключа нет, то возвращается ответ
415 Media not supported.
- Если заголовка
Acceptнет, то выбирается произвольный вариант ответа. - Если вариант контента выбран по ключу
*, тоContent-Typeответа будет выбран изhttp_headers. Если он там не указан, возвращается фактическийContent-Type.