Ocelot API 网关项目教程

1. 项目目录结构及介绍

Ocelot API 网关项目的目录结构如下：

awesome-ocelot/
├── docs/
│   └── images/
├── LICENSE
├── README.md
└── src/
    ├── Ocelot.API/
    ├── Ocelot.Core/
    ├── Ocelot.Extensions/
    └── Ocelot.Tests/

目录结构介绍

• docs/: 包含项目的文档和相关图片资源。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• src/: 项目的源代码目录。
  • Ocelot.API/: 包含API网关的核心实现。
  • Ocelot.Core/: 包含API网关的核心库和功能模块。
  • Ocelot.Extensions/: 包含API网关的扩展功能和插件。
  • Ocelot.Tests/: 包含API网关的单元测试和集成测试代码。

2. 项目的启动文件介绍

Ocelot API 网关的启动文件通常位于 Ocelot.API/ 目录下，主要包含以下文件：

• Program.cs: 项目的入口文件，负责配置和启动ASP.NET Core应用程序。
• Startup.cs: 配置应用程序的服务和中间件，包括Ocelot的配置和初始化。

Program.cs

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

Startup.cs

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddOcelot();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();
        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });

        app.UseOcelot().Wait();
    }
}

3. 项目的配置文件介绍

Ocelot API 网关的配置文件通常是一个JSON文件，位于项目的根目录或 src/ 目录下，文件名为 ocelot.json。

ocelot.json

{
  "ReRoutes": [
    {
      "DownstreamPathTemplate": "/api/{everything}",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 5001
        }
      ],
      "UpstreamPathTemplate": "/services/service1/{everything}",
      "UpstreamHttpMethod": [ "Get", "Post" ]
    }
  ],
  "GlobalConfiguration": {
    "BaseUrl": "http://localhost:5000"
  }
}

配置文件介绍

• ReRoutes: 定义了API网关的路由规则，包括下游服务的路径模板、协议、主机和端口，以及上游服务的路径模板和HTTP方法。
• GlobalConfiguration: 定义了API网关的全局配置，如API网关的基础URL。

通过以上配置，Ocelot API 网关能够根据请求的路径和方法，将请求转发到相应的下游服务。