getaway基本配置

Getaway 是一款用于容器化应用的轻量级 API 网关。它提供了一种简单的方式来管理和路由 API 请求，通常用于微服务架构中。以下是 Getaway 的基本配置指南，包括安装、配置文件示例、以及一些常见的配置选项。

### 1. 安装

Getaway 通常通过 Docker 容器来运行，以下是使用 Docker 安装和运行 Getaway 的步骤：

```bash
# 拉取 Getaway 的 Docker 镜像
docker pull getaway/getaway:latest

# 运行 Getaway 容器
docker run -d -p 8080:8080 --name getaway getaway/getaway:latest
```

### 2. 配置文件示例

Getaway 的配置文件通常是一个 JSON 或 YAML 格式的文件，用于定义路由规则和服务配置。以下是一个简单的配置文件示例：

#### JSON 格式

```json
{
"services": {
"serviceA": {
"host": "http://service-a.local",
"paths": ["/service-a"]
},
"serviceB": {
"host": "http://service-b.local",
"paths": ["/service-b"]
}
},
"routes": [
{
"path": "/service-a/*",
"service": "serviceA"
},
{
"path": "/service-b/*",
"service": "serviceB"
}
]
}
```

#### YAML 格式

```yaml
services:
serviceA:
host: http://service-a.local
paths:
- /service-a
serviceB:
host: http://service-b.local
paths:
- /service-b
routes:
- path: /service-a/*
service: serviceA
- path: /service-b/*
service: serviceB
```

### 3. 启动配置

将配置文件挂载到容器中，以便 Getaway 使用这些配置启动：

```bash
docker run -d -p 8080:8080 \
-v /path/to/config.json:/etc/getaway/config.json \
--name getaway getaway/getaway:latest
```

### 4. 配置选项详解

- **services**：定义服务及其基本信息。
- **host**：服务的主机地址。
- **paths**：该服务对应的路径前缀。

- **routes**：定义路由规则。
- **path**：请求路径匹配模式。
- **service**：该路径对应的服务。

### 5. 高级配置

除了基本的服务和路由配置，Getaway 还支持更高级的配置选项，例如身份验证、负载均衡、缓存等。以下是一些高级配置示例：

#### 身份验证

可以通过中间件配置来添加身份验证功能：

```json
{
"middleware": {
"auth": {
"type": "jwt",
"config": {
"secret": "your-secret-key",
"algorithms": ["HS256"]
}
}
},
"services": {
"serviceA": {
"host": "http://service-a.local",
"paths": ["/service-a"]
}
},
"routes": [
{
"path": "/service-a/*",
"service": "serviceA",
"middleware": ["auth"]
}
]
}
```

#### 负载均衡

可以为服务配置多个实例以实现负载均衡：

```json
{
"services": {
"serviceA": {
"hosts": [
"http://service-a1.local",
"http://service-a2.local"
],
"paths": ["/service-a"]
}
},
"routes": [
{
"path": "/service-a/*",
"service": "serviceA"
}
]
}
```

### 6. 日志与监控

Getaway 支持配置日志输出和监控，以便运维人员能够实时掌握网关的运行状态：

```json
{
"logging": {
"level": "info",
"output": "stdout"
},
"monitoring": {
"enabled": true,
"port": 9090
},
"services": {
"serviceA": {
"host": "http://service-a.local",
"paths": ["/service-a"]
}
},
"routes": [
{
"path": "/service-a/*",
"service": "serviceA"
}
]
}
```