Расширение x-yc-schema-mapping
Статья создана
Обновлена 30 июля 2024 г.
Расширение x-yc-schema-mapping позволяет преобразовывать JSON-тело запроса к интеграции или ответа от нее.
Расширение предназначено для объекта Schema из OpenAPI-спецификации.
Поддерживаемые параметры
В таблице ниже перечислены параметры, специфичные для API-шлюза сервиса API Gateway. Описание остальных параметров читайте в спецификации OpenAPI 3.0.
| Параметр | Тип | Описание |
|---|---|---|
type |
string |
Тип преобразования. Возможные значения: static — тело описано статичным ресурсом. |
template |
map[string]TemplateObject |
Полное описание тела в формате <название_поля>: "<значение_поля>". |
Спецификация расширения
Пример спецификации:
x-yc-schema-mapping:
type:static
template:
property1: "value1"
property2: "${.baseProperty1.baseProperty2}"
Пример преобразования тела ответа, где в ответ пользователю приходит сообщение из двух полей, если функция Cloud Functions возвращает код 200 и заголовок Content-Type: application/json:
openapi: "3.0.0"
info:
version: 1.0.0
title: Petstore API
paths:
/pets:
get:
responses:
'200':
description: Pet
content:
application/json:
schema:
type: object
x-yc-schema-mapping:
type: static
template:
Name: "Dog"
Breed: "${.nestedProperty1.nestedProperty2}"
x-yc-apigateway-integration:
type: cloud_functions
function_id: b095c95icn**********