# APIGatewaySample

**Repository Path**: qx918/apigateway-sample

## Basic Information

- **Project Name**: APIGatewaySample
- **Description**: asp.net core api 网关，使用 Ocelot + Consul + Skywalking
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-03-06
- **Last Updated**: 2025-03-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 网关, Aspnet

## README

# APIGateWaySample
**Ocelot + Consul + Skywalking**
## 简介
系统设计图
![System Design Diagram](https://gitee.com/qx918/apigateway-sample/raw/master/assets/SystemDesign.png)
### 网关
API网关（Gateway）是一个服务器，是系统的唯一入口。从面向对象设计的角度看，它与外观模式类似。API网关封装了系统内部架构，为每个客户端提供一个定制的API。它可能还具有其它职责，如身份验证、监控、负载均衡、缓存、限流等。

### 相关技术
##### 核心
- **Ocelot**：轻量级的.NET API网关
- **Consul**：服务发现和配置管理
- **Skywalking**：分布式系统的APM（应用性能监控）工具
##### 其它
- **Serilog**：日志。网关使用Serilog，将结构化的日志信息存储到ES(Elastic Search)，便于分析处理。
- **Elasticsearch**：是一个分布式、RESTful风格的搜索和分析引擎，具有以下特点：
  - 分布式实时文件存储，每个字段都被索引并可被搜索
  - 分布式实时分析搜索引擎
  - 可以扩展到上百台服务器，处理PB级结构化或非结构化数据
  - 在本项目中主要用于存储和分析系统日志数据
## 请求处理流程
- 用户请求API网关，网关根据Ocelot配置，处理和转发到下游服务（Service1,Service2...）。
- 各个服务注册到Consul，API网关通过服务发现的方式，向Consul请求下游服务的信息，从来实现转发。
- 网关等所有服务，集成到Skywalking，通过Skywalking监控应用的性能，包括调用链路，响应时间，异常等。
## 环境搭建
ES: 默认端口 9200
ES Head: 默认端口 9100
Skywalking: WEB默认端口 9091
Consul: 默认端口8500，设置好环境变量后，本地开发模式启动命令：consul agent -dev -node=127.0.0.1
## 代码
包：
- **Ocelot 23.4.3**：网关组件
ocelot.json
```json
{
  "Routes": [
    {
      "UseServiceDiscovery": true,
      "DownstreamPathTemplate": "/{abc}",
      "DownstreamScheme": "http",
      "ServiceName": "service1",
      "LoadBalancerOptions": { "Type": "RoundRobin" },
      "UpstreamPathTemplate": "/service1/{abc}",
      "UpstreamHttpMethod": [ "Get", "Post" ],
      "ReRoutesCaseSensitive": false
    }
  ],
  "GlobalConfiguration": {
    "BaseUrl": "http://localhost:8000",
    "ServiceDiscoveryProvider": {
      "Scheme": "http",
      "Host": "localhost",
      "Port": 8500,
      "Type": "Consul",
      "ConfigurationKey": "node-1"
    },
    "Logging": {
      "LogLevel": {
        "Default": "Trace"
      }
    }
  }
}
```
- **Ocelot.Provider.Consul 23.4.3**：Consul服务发现，使网关可以通过Consul服务发现下游服务，从而正确转发请求
- **Consul 1.7.14.7**：服务注册，将网关服务注册到Consul
- **SkyAPM.Agent.AspNetCore 2.2.0**：集成到Skywalking
skyapm.json
```json
{
  "SkyWalking": {
    "ServiceName": "api-gateway",
    "Namespace": "",
    "HeaderVersions": [
      "sw8"
    ],
    "Sampling": {
      "SamplePer3Secs": -1,
      "Percentage": -1.0
    },
    "Logging": {
      "Level": "Information",
      "FilePath": "logs\\skyapm-{Date}.log"
    },
    "Transport": {
      "Interval": 3000,
      "ProtocolVersion": "v8",
      "QueueSize": 30000,
      "BatchSize": 3000,
      "gRPC": {
        "Servers": "127.0.0.1:11800",
        "Timeout": 10000,
        "ConnectTimeout": 10000,
        "ReportTimeout": 600000,
        "Authentication": ""
      }
    }
  }
}
```
Program.cs引入配置文件
```c#
builder.Configuration.AddJsonFile("ocelot.json")
    .AddJsonFile($"ocelot.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", optional: true);
builder.Configuration.AddJsonFile("skyapm.json")
    .AddJsonFile($"skyapm.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", optional: true);
builder.Configuration.AddJsonFile("serilog.json")
    .AddJsonFile($"serilog.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", optional: true);
builder.Configuration.AddJsonFile("consul.json")
    .AddJsonFile($"consul.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", optional: true);
```
使用网关和服务发现
```c#
builder.Services.AddOcelot()
    .AddConsul(); //Consul 服务发现
builder.Services.AddHealthChecks();
...
await app.UseOcelot();
```
使用skywalking
```c#
builder.Services.AddSkyApmExtensions();
```
全部代码见： https://gitee.com/qx918/apigateway-sample 或 https://github.com/Xia-Qi/APIGatewaySample

## 运行效果图
![Consul service list](https://gitee.com/qx918/apigateway-sample/raw/master/assets/consul_services.png)
![Consul service detail](https://gitee.com/qx918/apigateway-sample/raw/master/assets/service_detail.png)
![Skywalking request trace]([assets/sky_get.png](https://gitee.com/qx918/apigateway-sample/raw/master/assets/sky_get.png))

## License

MIT License

Copyright (c) 2025

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.