.Net Core微服務入門全紀錄（完結）——Ocelot與Swagger
阿新 • • 發佈：2020-07-16
Tips：本篇已加入系列文章閱讀目錄，可點選檢視更多相關文章。
# 前言
上一篇【[.Net Core微服務入門全紀錄（八）——Docker Compose與容器網路](https://www.cnblogs.com/xhznl/p/13268940.html)】完成了docker-compose.yml檔案的編寫，最後使用docker compose的一個up指令即可在docker中執行整個複雜的環境。本篇簡單介紹一下Ocelot與Swagger的整合，方便在閘道器專案中統一檢視各個服務的api文件。
# 開始
首先，閘道器專案，服務專案 NuGet安裝`Swashbuckle.AspNetCore`：
## 服務專案
Order.API專案Startup：
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "Order API", Version = "v1", Description = "# order service api..." });
// Set the comments path for the Swagger JSON and UI.
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme()
{
Description = "在下框中輸入請求頭中需要新增Jwt授權Token：Bearer Token",
Name = "Authorization",
In = ParameterLocation.Header,
Type = SecuritySchemeType.ApiKey,
BearerFormat = "JWT",
Scheme = "Bearer"
});
c.AddSecurityRequirement(new OpenApiSecurityRequirement
{
{
new OpenApiSecurityScheme{
Reference = new OpenApiReference {
Type = ReferenceType.SecurityScheme,
Id = "Bearer"}
},new string[] { }
}
});
});
services.AddControllers();
......
}
```
```csharp
public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IHostApplicationLifetime lifetime, OrderContext orderContext)
{
......
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Order API V1");
});
app.UseRouting();
......
}
```
開啟專案檔案Order.API.csproj，新增生成文件的配置，swagger要用到：
```xml
true $(NoWarn);1591
```
Product.API專案也是類似的修改，就不貼了。
## 閘道器專案
然後是Ocelot閘道器專案的Startup：
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1",
new OpenApiInfo {Title = "Gateway API", Version = "v1", Description = "# gateway api..."});
});
services.AddControllers();
......
}
```
```csharp
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseSwagger();
app.UseSwaggerUI(c =>