.net core2.2 Swagger如何在请求标头加入请求标识

Question

.net core2.2 Swagger如何在请求标头加入请求标识，目的是区分swagger接口来自哪台服务器。

Answer 1

本答案参考 多次询问 ChatGPT-3.5 后选择的最佳回答，若是满意，还请采纳，谢谢

1. 安装必要的包

   • 确保你的项目已经安装了Swashbuckle.AspNetCore包。如果没有，可以通过NuGet包管理器进行安装。

2. 添加请求标识中间件（可选）

   • 首先，你可以创建一个中间件来添加请求标识到请求头中。例如，创建一个名为RequestIdentifierMiddleware的类：
     ```csharp
     using Microsoft.AspNetCore.Http;
     using System.Threading.Tasks;

   public class RequestIdentifierMiddleware
   {

   private readonly RequestDelegate _next;
   private const string RequestIdentifierHeaderKey = "X - Request - Identifier";
   
   public RequestIdentifierMiddleware(RequestDelegate next)
   {
       _next = next;
   }
   
   public async Task Invoke(HttpContext context)
   {
       // 这里可以根据服务器的相关信息生成一个唯一标识，例如服务器名称或IP等
       string requestIdentifier = "Server1";// 假设这是服务器标识，可以根据实际情况修改
       context.Request.Headers[RequestIdentifierHeaderKey] = requestIdentifier;
       await _next(context);
   }
   

   }

   - 在`Startup.cs`的`Configure`方法中添加这个中间件：
   ```csharp
   public void Configure(IApplicationBuilder app, IHostingEnvironment env)
   {
       //...其他中间件配置
   
       app.UseMiddleware<RequestIdentifierMiddleware>();
   
       //...其他中间件配置
   }
   

3. 在Swagger中显示请求头

   • 在Startup.cs的ConfigureServices方法中，配置Swagger来显示这个请求头。

     public void ConfigureServices(IServiceCollection services)
     {
       services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
     
       services.AddSwaggerGen(c =>
       {
           c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
     
           // 添加请求头参数到Swagger
           c.OperationFilter<AddRequiredHeaderParameter>();
       });
     }
     

   • 这里需要创建一个名为AddRequiredHeaderParameter的IOperationFilter实现类：
     ```csharp
     using Microsoft.OpenApi.Models;
     using Swashbuckle.AspNetCore.SwaggerGen;
     using System.Collections.Generic;

   public class AddRequiredHeaderParameter : IOperationFilter
   {

   public void Apply(OpenApiOperation operation, OperationFilterContext context)
   {
       if (operation.Parameters == null)
       {
           operation.Parameters = new List<OpenApiParameter>();
       }
   
       operation.Parameters.Add(new OpenApiParameter
       {
           Name = "X - Request - Identifier",
           In = ParameterLocation.Header,
           Required = true,
           Schema = new OpenApiSchema
           {
               Type = "string"
           }
       });
   }
   

   }
   ```

通过以上步骤，就可以在Swagger的请求头中添加请求标识，并且在实际的请求处理中也会包含这个请求标识，从而区分请求来自哪台服务器。需要注意的是，在实际应用中，请求标识的生成应该根据服务器的实际情况准确生成，如使用服务器的主机名、IP地址或者其他唯一标识信息。