OSCHINA-MIRROR/libfintech-wechat_api

微信API网关

1. Функциональное описание

Данный проект представляет собой API-шлюз, реализованный на основе Koa2-фреймворка, который использует механизм промежуточного программного обеспечения Koa2 для предоставления функций плагинов.

Используя комбинацию плагинов, таких как регистрация и обнаружение сервисов через публичные аккаунты WeChat, обратный прокси и другие, можно эффективно решать проблемы с единым доступом, распределением и мониторингом запросов от различных клиентских и серверных приложений.

Поддерживается возможность создания пользовательских плагинов.

2. Описание среды

Используется NodeJS версии 8.x.x (https://nodejs.org/en/).

3. Описание плагинов

Принцип работы: после получения запроса, объекты запроса, ответа, сессии и журнала упаковываются в конвейерные объекты, которые последовательно передаются каждому плагину. Каждый плагин выполняет одну функцию, и несколько плагинов объединяются для реализации одной функции. Можно настраивать комбинации плагинов для достижения различных функций. Например, плагин WeChat Gateway отвечает только за преобразование формата сообщений WeChat, а в сочетании с плагинами переноса запросов и обратного прокси он может выполнять функцию распределения запросов на разные серверы.

На рисунке ниже представлена схема принципа работы конвейерного механизма. Необходимо настроить и включить плагин обратного прокси (proxy).

Использование: обратитесь к библиотеке плагинов API Gateway (https://gitee.com/libfintech/api_gateway_plugin).

4. Описание конфигурации приложения

Скопируйте файл app_config.js.example в app_config.js и сохраните его в корневом каталоге проекта.

В примере уже настроены следующие плагины:

журнал отслеживания (https://gitee.com/libfintech/api_gateway_plugin/tree/master/log_trace);
IP белый список и чёрный список (https://gitee.com/libfintech/api_gateway_plugin/tree/master/ip);
аутентификация (https://gitee.com/libfintech/api_gateway_plugin/tree/master/authe);
WeChat Gateway (https://gitee.com/libfintech/api_gateway_plugin/tree/master/wx_gateway);
перенос запросов (https://gitee.com/libfintech/api_gateway_plugin/tree/master/transfer);
обратный прокси (https://gitee.com/libfintech/api_gateway_plugin/tree/master/proxy);
ответ WeChat Gateway (https://gitee.com/libfintech/api_gateway_plugin/tree/master/wx_gateway_response).

Конкретные параметры конфигурации:

port	порт приложения
log	rootPath: путь к корню журнала, настраиваемый, например, /xxx/xxx/wechat_api_gateway ключ идентификатора трассировки журнала, настраиваемый. Следующие три значения являются значениями по умолчанию для Spring Cloud Sleuth traceIdKey: x-b3-traceid, spanIdKey: x-b3-spanid, parentSpanIdKey: x-b3-parentspanid
runningMode	режим работы, автономный режим (standalone) или кластерный режим (cluster)
mpConfigName	имя конфигурации публичного аккаунта, в автономном режиме это имя файла конфигурации, в кластерном режиме это ключ redis
redis	конфигурация redis, игнорируется в автономном режиме, обязательна в кластерном режиме ip: IP-адрес port: порт pass: пароль
plugins	список конфигураций плагинов, порядок конфигурации определяет порядок запуска path: путь плагина config_path: каталог конфигурации плагина enable: включить ли

OSCHINA-MIRROR/libfintech-wechat_api_gateway

Комментарии ( 0 )

Введение

Обновления

Участники

Недавние действия