https://github.com/ooclab/ga
A lightweight middleware for service-oriented architecture
https://github.com/ooclab/ga
apigateway golang microservice middleware openai plugable service-oriented
Last synced: 16 days ago
JSON representation
A lightweight middleware for service-oriented architecture
- Host: GitHub
- URL: https://github.com/ooclab/ga
- Owner: ooclab
- Created: 2018-10-20T05:15:07.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-01-01T04:10:34.000Z (about 2 years ago)
- Last Synced: 2024-06-20T14:21:07.626Z (almost 2 years ago)
- Topics: apigateway, golang, microservice, middleware, openai, plugable, service-oriented
- Language: Go
- Homepage:
- Size: 9.08 MB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Guardian Angel
**G**uardian **A**ngel is a lightweight middleware for service-oriented architecture.
What is the `service-oriented` here ?
1. `big services` : export a http(s) api
2. `small services`
- microservices / nanoservices
- serverless / FaaS
We don't want to argument the term, we just want to do right job.
:-)
Current Support:
- \[x] custom your middleware with golang plugin ( [third-party-middleware](https://github.com/urfave/negroni#third-party-middleware) )
Current Middlewares:
- \[x] [openai](./middlewares/openai) : as a gateway of openai, custom your key and limit the request count
- \[x] [hello](./middlewares/hello) : for example
- \[x] [jwt](./middlewares/jwt) : decode JWT (from `Authorization` in HTTP Request Header), and set `X-User-Id` header by user id
- \[x] [addauth](./middlewares/addauth) : manage `access_token` and `refresh_token` , add JWT with `Authorization` in HTTP Request Header auto
- \[x] [openapi](./middlewares/openapi) : authorize permissions and validate request args with OpenAPI 2.0 Spec Document of the backend service
- \[x] [debug](./middlewares/debug) : print http request data when debug is enable
- \[ ] openapi-response : check the response for testing
------
## 目录
- [作为 openai 的网关](./docs/openai-gateway.md)
- [为什么开发 ga ？](./docs/reason.md)
- [ideas](./docs/ideas.md)
- [istio](./docs/istio.md)
- [与 es 配合架构思考](./docs/add-es.md)
- [authz](./docs/authz.md)
- [docker build image](./docs/docker.md)
ga 架构示例：
- [ga 架构一](./docs/arch-design/arch1.md)
### 进展
#### 已完成
- \[x] 支持启动任意数量的 forwarder ，每个 forwarder 可以自由搭配任意数量的 middlewares
- \[x] 支持 golang plugin 方式写自定义的 middleware 。 可以查看示例： [hello](https://github.com/ooclab/ga/tree/master/middlewares/hello)
#### TODO
- [ ] 支持提供 TLS 服务：指定证书和私钥或使用 letsencrypt 申请并自动更新证书（参考 caddy 和 traefik ）。避免使用文件系统存放证书，而是使用 etcd 存放证书（分布式）。
- [ ] 使用 etcd 或类似服务作为统一分布式存储，主程序和 middleware 都可以使用 etcd 存储和读取数据及配置，提供统一内部 API 供主程序和 middleware 使用。
- 存储可以考虑单机（kv）或分布式（etcd）2种方式，提供统一的 store 抽象。
- main, middleware 的配置和数据（监控），以及 let's encrypt 的证书都需要存储。
## Contact
- info@ooclab.com