https://github.com/yandex-cloud-examples/yc-serverless-apigw-hello-world-typescript
Пример интеграции API Gateway и Yandex Cloud Functions с использованием контекста операции.
https://github.com/yandex-cloud-examples/yc-serverless-apigw-hello-world-typescript
serverless typescript yandex-cloud yandex-function yandexcloud
Last synced: 7 months ago
JSON representation
Пример интеграции API Gateway и Yandex Cloud Functions с использованием контекста операции.
- Host: GitHub
- URL: https://github.com/yandex-cloud-examples/yc-serverless-apigw-hello-world-typescript
- Owner: yandex-cloud-examples
- License: apache-2.0
- Created: 2024-03-13T19:58:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-16T06:22:06.000Z (8 months ago)
- Last Synced: 2025-02-16T07:20:51.455Z (8 months ago)
- Topics: serverless, typescript, yandex-cloud, yandex-function, yandexcloud
- Language: TypeScript
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Typescript Cloud Function Example
Пример интеграции API Gateway и Cloud Functions с использованием контеста операции.
Контекст операции - это параметр context расширения
[x-yc-apigateway-integration:cloud_functions](https://cloud.yandex.ru/docs/api-gateway/concepts/extensions/cloud-functions)
OpenAPI-спецификации. Значение данного параметра может иметь вложенную структуру, но ограничено размером в 2Kbyte.
Контекст операции позволяет параметризовать функцию-интеграцию для набора типовых операций OpenAPI-спецификации.
В примере API-гейтвей передает в функцию значение параметра пути запроса `/{name}` через поле
`requestContext.apiGateway.operationContext.name`
[контекста операции](https://cloud.yandex.ru/docs/functions/concepts/function-invoke#request)
## Запуск
1. Выполните `npm install` для установки зависимостей
2. Выполните `npm run build` для сборки проекта
3. Создайте облачную функции, в качестве среды выполнения выберите Node.js и вставьте код из build/index.js
4. Создайте API Gateway и вставьте спецификацию из [openapi-example.yaml](openapi-example.yaml),
подставив в неё идентификатор ранее созданной функции
Для тестирования откройте в браузере `https://<служебный домен созданного API-шлюза>/world`
## Запуск функции из терминала
1. Выполните `npm install` для установки зависимостей
2. Выполните `npm run build` для сборки проекта
3. Выполните `node build/main []`, передав аргументом json-запрос
## Тесты
npm run test