如何将ASP.NETCore与Ocelot网关结合，高效配置并使用Swagger进行API文档管理？

本文共计648个文字，预计阅读时间需要3分钟。

1. 前言+前端与后端的连接更多是通过API接口对接，API文档变成了前后端开发人员联系的纽带，其重要性越来越明显。例如，使用Swagger就是一款让你更高效地书写API文档的框架。在Ocelot+Swagger项目中，...

1.前言

前端与后端的联系更多是通过API接口对接，API文档变成了前后端开发人员联系的纽带，开始变得越来越重要，而Swagger就是一款让你更好的书写规范API文档的框架。在Ocelot Swagger项目示例中，通过APIGateway项目路由配置网关、上下游服务Swagger。对解决方案中的示例APIServiceA、APIServiceB项目Get方法进行配置，文件配置具体代码如下：

{ "Routes": [ { //下游服务地址 "DownstreamPathTemplate": "/swagger/v1/swagger.json", //传输协议 "DownstreamScheme": "*:9000") .ConfigureAppConfiguration((hostingContext, config) => { config .SetBasePath(hostingContext.HostingEnvironment.ContentRootPath) .AddJsonFile("ocelot.json") .AddEnvironmentVariables(); }) .ConfigureServices(s => { //添加Ocelot服务； s.AddOcelot(); s.AddMvc(); //添加Swagger服务； s.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "GW", Version = "v1" }); var basePath = PlatformServices.Default.Application.ApplicationBasePath; var xmlPath = Path.Combine(basePath, "APIGateway.xml"); c.IncludeXmlComments(xmlPath); }); }) .Configure(a => { //使用Swagger a.UseSwagger().UseSwaggerUI(c => { c.SwaggerEndpoint("/a/swagger/v1/swagger.json", "APIServiceA"); c.SwaggerEndpoint("/b/swagger/v1/swagger.json", "APIServiceB"); }); //使用Ocelot； a.UseOcelot().Wait(); }) .Build();

2.2APIServiceA项目

Startup添加Swagger服务注入：
ConfigureServices：

services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "APIServiceA", Version = "v1" }); var basePath = PlatformServices.Default.Application.ApplicationBasePath; var xmlPath = Path.Combine(basePath, "APIServiceA.xml"); c.IncludeXmlComments(xmlPath); }); Configure： app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "APIServiceA"); });

添加一个Get方法，对应APIGateway项目的路由上下游配置，具体代码如下：

/// <summary> /// Values controller. /// </summary> [Route("a")] public class ValuesController : Controller { // GET api/values /// <summary> /// Get values. /// </summary> /// <returns>The get.</returns> [HttpGet] public IEnumerable<string> Get() { return new string[] { "value1", "value2" }; } }

2.3APIServiceB项目

Startup添加Swagger服务注入：
ConfigureServices：

services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "APIServiceB", Version = "v1" }); var basePath = PlatformServices.Default.Application.ApplicationBasePath; var xmlPath = Path.Combine(basePath, "APIServiceB.xml"); c.IncludeXmlComments(xmlPath); });

Configure：

app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "APIServiceB"); });

添加一个Get方法，对应APIGateway项目的路由上下游配置，具体代码如下：

/// <summary> /// Values controller. /// </summary> [Route("b")] public class ValuesController : Controller { // GET api/values /// <summary> /// Get values. /// </summary> /// <returns>The get.</returns> [HttpGet] public IEnumerable<string> Get() { return new string[] { "value3", "value4" }; } }

2.4项目运行

注：如果想把Swagger注释警告提示取消，可以在对应项目文件.csproj的PropertyGroup节点上加入<NoWarn>$(NoWarn);1591</NoWarn>这一行代码。
输入dotnet run --project 项目路径\项目文件.csproj把三个项目启动起来，通过在浏览器分别打开APIServiceA与APIServiceB两个站点上游服务Swagger地址，会看到如下信息：
APIServiceA：

APIServiceB：

通过网关的路由配置，把Swagger集成到Ocelot中，统一入口管理，通过网关入口我们就能打开不同下游服务的Swagger。

到此这篇关于ASP.NET Core为Ocelot网关配置Swagger的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持自由互联。