Универсальные компоненты для подключения к шлюзу: openapi-client-provider

Введение

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

Адрес: http://acooly.cn/docs/component.html?type=gateway

Спецификации разработки

Спецификации компонентов

• Спецификация поставщика: каждый компонент должен иметь уникальное глобальное имя поставщика. Например, bosc. Если одна и та же организация предоставляет несколько услуг (с разными протоколами), то имена поставщиков должны соответствовать следующей спецификации: providerName-xxx, например, bosc, bosc-b2b, bosc-account и т. д.

• Спецификации модулей: openapi-client-provider-${provider}-${providerProduct}, где providerProduct является необязательным. Обычно, если у организации есть только один продукт, можно опустить этот параметр (или если вы первый разработчик этого поставщика).

• Пакеты программ: com.acooly.openapi.client.provider.${provider}.${providerProduct}. Имя пакета программы вашего компонента также должно быть уникальным в глобальном масштабе. Поскольку в одном целевом проекте может быть интегрировано несколько провайдеров, а также все компоненты могут быть протестированы в модульных тестах, важно убедиться, что ваш компонент является универсальным и независимым, добавив зависимости и проведя тестирование в модульных тестах.

• Модульное тестирование: каждый компонент должен быть добавлен как зависимость в модуль openapi-client-test и протестирован. Основные цели тестирования включают:

  • Проверка на конфликты после интеграции с другими компонентами.
  • Тестирование доступности и функциональности разработанного вами клиента, включая конфигурацию.

Документация модуля

Каждый модуль представляет собой отдельный клиент шлюза и имеет соответствующую документацию по интерфейсам и описаниям шлюзов. Рекомендуется использовать название модуля в качестве имени каталога и загрузить всю связанную документацию в вики-репозиторий проекта.

Файл описания модуля

В каждом модуле должен быть файл README.md, содержащий описание модуля. Необходимо указать в этом файле следующую информацию: краткое описание провайдера (для чего предназначен, какие проблемы решает, какие возможности предоставляет), краткое описание шлюза (включая протокол, XML, JSON, режим подписи, режим шифрования, тестовый адрес, производственный адрес и т.д.), основные проекты использования, ответственные лица и т.п.

Ответственные за модуль

У каждого модуля должен быть назначен ответственный. Это должно быть указано в файле README в корневом каталоге модуля.

Независимость модуля

Цель размещения всех модулей провайдера в одном проекте — предоставить команде возможность консолидировать опыт. Однако каждый модуль полностью независим, и разработчики (коммиттеры) не должны вносить код других людей в свои модули по любой причине.

Примечание: Для получения полного примера спецификаций, пожалуйста, обратитесь к модулю openapi-client-provider-bosc.

Спецификации управления кодом

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

Базовая библиотека компонентов https://acooly.cn/docs/component.html?type=infrastructure

• Компонент отправки коротких сообщений.
• Веб-компонент.
• Защитный компонент.
• Распределённый компонент кэша.
• Компонент доступа к объектному хранилищу.
• JPA-компонент.
• Tomcat-компонент.
• Фильтр-компонент.
• Компонент пула соединений с базой данных.
• Верхний слой файлового компонента.
• Компонент событий.
• Mybatis-компонент.
• Пул потоков-компонент.
• Dubbo-компонент.
• Генератор серийных номеров-компонент.

Библиотека прикладных компонентов https://acooly.cn/docs/component.html?type=app

• Appservice-компонент.
• Административный компонент безопасности.
• Мобильный компонент приложения.
• Журнал аудита-компонент.
• Реальный/карточный аутентификационный компонент.
• Графический компонент.
• Динамический табличный компонент.
• Почтовый компонент отправки.
• Распределенный компонент сообщений.
• Код подтверждения-компонент.
• Компонент подключения к WeChat.
• Чат-компонент IM.
• Pdf-компонент.
• Распределённый блокировочный компонент.
• Белый ящик тестирования-компонент.
• Распределённая задача таймера-компонент.
• Шифрование и дешифрование-компонент.
• Национально-региональный компонент.
• Параметрический конфигурационный компонент.

Портальная библиотека компонентов https://acooly.cn/docs/component.html?type=portlets

• Push-уведомления-компонент.
• Журнальный компонент действий.
• Комментарий-компонент.
• Обратная связь-компонент.

Бизнес-библиотека компонентов https://acooly.cn/docs/component.html?type=business

• Членский компонент.
• Лотерея-компонент.
• Бухгалтерский учёт-компонент.
• Интеграционный компонент.
• Красный конверт-компонент.
• Игровой счётчик-компонент.

Платформа OpenApi-шлюза https://acooly.cn/docs/component.html?type=openapi

• OpenApiSDK-компонент.
• Руководство по подключению OpenApi.
• Автоматизация документации OpenApi, открытая платформа.
• Асинхронное уведомление службы OpenApi.
• Разработка руководства по сервису OpenApi.

Пожертвования

Если у вас есть вопросы или нужна консультация, пожалуйста, добавьте меня в WeChat.

Если вам нравится наш открытый исходный код, пожалуйста, поставьте лайк. Это наша награда.

Если вам нравится наш открытый исходный код, пожалуйста, поставьте лайк. Это наша награда.

Если вам нравится наш открытый исходный код, пожалуйста, поставьте лайк. Это наша награда.