如何使用.NET8MapIdentityApi设置OpenApi操作ID

发布于11月25日

Is there an option to dynamically set the OperationId for paths that are generated by MapIdentityApi in .NET 8?个

我注意到我可以用WithOpenApi设置操作ID，但它似乎只对静态设置有效.或者有没有办法使用OpenApi动态设置操作ID？:

app.MapGroup("/auth").MapIdentityApi<User>().WithOpenApi(operation => new OpenApiOperation(operation)
{
    // Sets it to a static value
    OperationId = "Test"
});

我的目标是最终得到如下所示的操作ID:

"paths": {
    "/auth/register": {
      "post": {
        "operationId": "Auth_Register_Post",
      }
    },
    "/auth/login": {
      "post": {
        "operationId": "Auth_Login_Post",
      }
    },
    "/auth/refresh": {
      "post": {
        "operationId": "Auth_Refresh_Post",
      }
    },

Program.cs(启动)

在Swagger生成过程中，将SwaggerOperationIdFilter注册为操作筛选器.

services.AddSwaggerGen(options =>
{
  options.OperationFilter<SwaggerOperationIdFilter>();
  // ... other SwaggerGen configurations
}

SwaggerOperationIdFilter.cs的实现

public class SwaggerOperationIdFilter : IOperationFilter
{
  public void Apply(OpenApiOperation operation, OperationFilterContext context)
  {
    // Check if it's a MapIdentityApi action
    if (context.ApiDescription.ActionDescriptor is not ControllerActionDescriptor controllerActionDescriptor)
    {
      var relativePath = context.ApiDescription.RelativePath ?? "";
      operation.OperationId = $"{GenerateOperationIdBaseString(relativePath)}_{context.ApiDescription.HttpMethod}";
      return;
    }

    // For other controller actions, set OperationId based on controller and action names
    operation.OperationId = $"{controllerActionDescriptor.ControllerName}_{controllerActionDescriptor.ActionName}_{context.ApiDescription.HttpMethod}";
  }

  // Helper Method to extract the controller and the action name
  private static string GenerateOperationIdBaseString(string inputString)
  {
    var input = inputString.Split('/');
    if (input.Length == 0)
    {
      return string.Empty;
    }

    var controllerName = input[0].FirstCharToUpper();
    var actionName = string.Join("", input.Skip(1).Select(word => word.FirstCharToUpper()));
        
    return $"{controllerName}_{actionName}";
  }
}