From da6edbb04702a1a9164f9e299eeb7b8195225088 Mon Sep 17 00:00:00 2001 From: sunface Date: Tue, 18 Sep 2018 19:50:30 +0800 Subject: [PATCH] update readme --- Readme.md | 49 +++++++++++++++++++++++++++----- api/api_server.go | 2 +- {api/sql_data => sql}/.DS_Store | Bin {api/sql_data => sql}/juz.sql | 0 4 files changed, 43 insertions(+), 8 deletions(-) rename {api/sql_data => sql}/.DS_Store (100%) rename {api/sql_data => sql}/juz.sql (100%) diff --git a/Readme.md b/Readme.md index 5802b023..0e51b894 100644 --- a/Readme.md +++ b/Readme.md @@ -1,9 +1,44 @@ -# juz +#Juz +juz全称是桔子网关,是我们为了解决企业的痛点,专门研发的一套完全开源的网关。 -## requirement -- Go1.11 or higher(We are using go module here) +对于传统的开源网关,存在几个主要的问题: +- 可配置性和可管理性不好 +- 性能不够高 +- 功能不够丰富 +- 没有完善的管理权限控制 +- 监控缺失 -## Build&Run -```bash -> go build -> ./juz api \ No newline at end of file +有鉴于此,我们重新开发了一套企业级别的网关,并且已经在内部使用2年之久,受到广泛好评,因此特地开源出来,让大家都能享受到优秀的API网关带来的便利性。 + +![Juz简图](https://upload-images.jianshu.io/upload_images/8245841-09ab7c05653b1bfd.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240) + +桔子具有以下功能和特性(部分还在开发中) +1. 流量代理 +- 支持HTTP1.1/HTTP2/HTTPS/Websocket +- 请求调度 +- 版本控制 +- 鉴权、验签 todo p2 +- 黑白名单 +- 限速、限额 todo p0 +- 熔断 todo p1 +- 请求重试 +- 结果缓存 todo p3 +- 流量路由(金丝雀) + +2. 应用防火墙WAP +- 拦截Web入侵:SQL注入/命令注入/XSS/Webshell上传等等 +- 应用层DDOS防范 +- 应对CC攻击和刷量场景 +- 联动检测 + +3. 数据分析 +- 访问日志 +- 数据统计 +- 开发数据接口 +- 流量深度分析 + +4. 监控告警 +- 流量异常监控 +- 基于OpenAPM的全链路监控 +- 全链路日志 +- 应用健康检查 \ No newline at end of file diff --git a/api/api_server.go b/api/api_server.go index 1a203870..1e2fa815 100644 --- a/api/api_server.go +++ b/api/api_server.go @@ -35,7 +35,7 @@ func (p *ApiServer) Start() { misc.InitMysql() // 从mysql中加载所有的api信息到内存中 - p.loadData() + p.loadData() p.manage = &manage.Manage{} go p.manage.Start() diff --git a/api/sql_data/.DS_Store b/sql/.DS_Store similarity index 100% rename from api/sql_data/.DS_Store rename to sql/.DS_Store diff --git a/api/sql_data/juz.sql b/sql/juz.sql similarity index 100% rename from api/sql_data/juz.sql rename to sql/juz.sql