Если вы хотите использовать spring-cloud для создания открытой платформы, вы можете обратиться к другому проекту автора: SOP.

easyopen

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

Функции easyopen похожи на открытую платформу Taobao, все её интерфейсы предоставляют только один URL, а различные бизнес-операции различаются через параметры. Это упрощает управление URL-адресами интерфейса, и администратору платформы нужно только поддерживать параметры интерфейса. Поскольку количество параметров известно, это позволяет в значительной степени их инкапсулировать. После инкапсуляции разработчику платформы нужно написать только бизнес-код, а другие функции могут быть реализованы через конфигурацию.

Благодаря функциям аннотаций Java и управлению компонентами Spring, наша открытая интерфейсная платформа была создана.

Особенности функций

• Простота использования: после написания бизнес-кода можно сразу же запустить сервис без дополнительной настройки.
• Автоматическая проверка параметров: поддерживает интернациональную проверку параметров (JSR-303).
• Независимость проверки функций и возврата результатов: удобно для пользовательской реализации или расширения.
• Определение интерфейса с помощью аннотаций: простота и удобство обслуживания.
• Поддержка i18n интернационализации сообщений возврата.
• Автоматическое создание страниц документации, похожих на swagger.
• Цифровая подпись для проверки параметров: алгоритм подписи см. в easyopen\алгоритм подписи.txt.
• Подключение к платформе с использованием appKey-secret: необходимо предоставить подключаемому объекту appKey и secret.

Технические моменты

• Алгоритмы шифрования (MD5, AES, RSA).
• Netty (кодирование и декодирование, длительное соединение, восстановление после разрыва соединения).
• Ограничение скорости (стратегия дырявого ведра, стратегия токенов).
• Права доступа (RBAC, проверка).
• Сессия (одноузловая, распределённая).
• Аннотации (создание документации).
• Токен (jwt, accessToken).
• SDK (Java, C#, JavaScript).

Структура диаграммы

• Снимок экрана центра конфигурации

Страница документа

Пример

• Определение интерфейса:

@Api(name = "goods.get")
public Goods getGoods(GoodsParam param) {
    Goods goods = new Goods();
    goods.setId(1L);
    goods.setGoods_name("苹果iPhoneX");
    goods.setPrice(new BigDecimal(8000));
    return goods;
}

• Запрос данных:

{
  "name": "goods.get",
  "version": "",
  "app_key": "test",
  "data": "%7B%22goodsPrice%22%3A%22%22%2C%22goods_name%22%3A%22iphoneX%22%7D",
  "timestamp": "2018-03-22 13:48:58",
  "format": "json",
  "sign": "C946ACA5AC95B1790511764A10E675B7"
}

• Ответ:

{
    "code":"0",
    "data":{
        "goods_name":"苹果iPhoneX",
        "id":1,
        "price":8000
    }
}

Описание проекта

• easyopen: основной код easyopen.
• easyopen-configuration: центр конфигурации (необязательно).
• easyopen-demo: демонстрационный серверный интерфейс (включая springboot, springmvc).
• easyopen-ext: пакет расширения (предоставляет расширенные функции, такие как прерывание цепи и понижение уровня).
• easyopen-sdk: соответствующий интерфейс SDK (включая Java, C#, Javascript).
• easyopen-starter: стартер springboot.
• develop-doc: документация по разработке.

Инструкция по использованию

1. Запустите easyopen-demo/easyopen-server-manual (бизнес-код находится в GoodsApi.java).
2. Запустите sdk-java/SdkTest.java в easyopen-sdk.

Страница документа: http://localhost:8080/api/doc

Документация по разработке

Документация по разработке easyopen

Офлайн-версия: см. readme.md в develop-doc.