1 Star 0 Fork 658

endless / easyopen

forked from tanghc / easyopen 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md
MIT

如果您想使用spring-cloud来搭建一个开放平台,可参考作者另外一个项目:SOP

easyopen

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

easyopen的功能类似于淘宝开放平台,它的所有接口只提供一个url,通过参数来区分不同业务。这样做的好处是接口url管理方便了,平台管理者只需维护好接口参数即可。由于参数的数量是可知的,这样可以在很大程度上进行封装。封装完后平台开发者只需要写业务代码,其它功能可以通过配置来完成。

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

功能特点

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

技术点

  • 加密算法(MD5、AES、RSA)
  • Netty(编解码、长连接、断开重连)
  • 限流(漏桶策略、令牌桶策略)
  • 权限(RBAC、校验)
  • session(单机、分布式)
  • 注解(文档生成)
  • token(jwt、accessToken)
  • SDK(Java、C#、JavaScript)

结构图

easyopen架构

  • 配置中心截图

配置中心截图

文档页面

文档

示例

  • 定义接口:
@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:接口服务端demo(含springboot,springmvc)
  • easyopen-ext:扩展包(提供增强功能如熔断降级等功能)
  • easyopen-sdk:接口对应的SDK(含Java,C#,Javascript)
  • easyopen-starter:springboot对应的starter
  • develop-doc:开发文档

使用说明

  1. 启动easyopen-demo下的easyopen-server-manual(业务代码在GoodsApi.java中)
  2. 运行easyopen-sdk下的sdk-java中的SdkTest.java

文档页面:http://localhost:8080/api/doc

开发文档

easyopen开发文档

离线版:参见develop-doc/readme.md

The MIT License (MIT) Copyright (c) 2018 durcframework Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一个简单易用的接口开放平台,平台封装了常用的参数校验、结果返回等功能,开发者只需实现业务代码即可。 展开 收起
Java
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/endlesshh/easyopen.git
git@gitee.com:endlesshh/easyopen.git
endlesshh
easyopen
easyopen
master

搜索帮助

F2647f8d 8189591 Bbdfb06e 8189591