一个简单易用的接口开放平台

easyopen

一个简单易用的接口开放平台，平台封装了经常使用的参数校验、结果返回等功能，开发者只需实现业务代码便可。

easyopen的功能相似于淘宝开放平台，它的全部接口只提供一个url，经过参数来区分不一样业务。这样作的好处是接口url管理方便了，平台管理者只需维护好接口参数便可。因为参数的数量是可知的，这样能够在很大程度上进行封装。封装完后平台开发者只须要写业务代码，其它功能能够经过配置来完成。

得益于Java的注解功能以及Spring容器对bean的管理，咱们的开放接口平台就这样产生了。

功能特色

• 开箱即用，写完业务代码直接启动服务便可使用，无需其它配置。
• 参数自动校验，支持国际化参数校验（JSR-303）。
• 校验功能和结果返回功能实现各自独立，方便自定义实现或扩展。
• 采用注解来定义接口，维护简单方便。
• 支持i18n国际化消息返回。
• 自动生成文档页面，相似swagger。
• 采用数字签名进行参数验证，签名算法见：easyopen签名算法.txt。
• 采用appKey-secret形式接入平台，即须要给接入方提供一个appKey和secret。

技术点

• 加密算法（MD五、AES、RSA）
• Netty（编解码、长链接、断开重连）
• 多线程（等待唤醒、CountDownLatch）
• 限流（限流策略、分布式限流）
• 权限（RBAC、校验）
• session（单机、分布式）
• 注解（文档生成）
• token（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
    }
}

源码