Início / coding / Perguntas / 79584742
Accepted
Bruno Casarotti
Asked: 2025-04-21 21:46:27 +0800 CST

Como usar camel case em parâmetros de string de consulta e OpenAPI no .NET 9 com API mínima?

  • 772

Quero que minha especificação JSON do OpenAPI use Camel Case em todos os parâmetros de string de consulta para minhas rotas. Até agora, a única maneira de fazer isso funcionar foi usando [FromQuery(Name = "camelCase")]em todas as minhas propriedades. Existe uma maneira melhor de definir essa configuração em algum lugar para que eu não precise fazer essas alterações em todas as propriedades da minha API?

public class UsageQueryParams
{
    [FromQuery(Name = "contractType")] public ContractType? ContractType { get; set; }
    [FromQuery(Name = "limit")] public long? Limit { get; set; }
}
c#

1 respostas

  1. Best Answer

    Supondo que você esteja usando a versão atual Microsoft.AspNetCore.OpenApi(desde o .NET 9), você pode aproveitar a funcionalidade de transformadores criada para a personalização de documentos OpenAPI . Por exemplo, uma abordagem rápida e prática pode ser:

    builder.Services.AddOpenApi(o =>
{
    o.AddOperationTransformer((operation, context, ct) =>
    {
        var openApiParameters = operation.Parameters;
        foreach (var parameter in openApiParameters)
        {
            parameter.Name = System.Text.Json.JsonNamingPolicy.CamelCase.ConvertName(parameter.Name);
        }
        return Task.CompletedTask;
    });
});

    Com o seguinte ponto final:

    app.MapGet("/testcase", ([AsParameters]UsageQueryParams p) => p);
//...
public class UsageQueryParams
{
    [FromQuery] public ContractType? ContractType { get; set; }
    [FromQuery] public long? LimitLength { get; set; }
    [FromQuery] public string TestString { get; set; }
}

    resultando no json gerado:

    "paths": {
"/testcase": {
  "get": {
    "tags": [
      "MinimalApisCamelCase"
    ],
    "parameters": [
      {
        "name": "contractType",
        "in": "query",
        "schema": {
          "type": "integer"
        }
      },
      {
        "name": "limitLength",
        "in": "query",
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      {
        "name": "testString",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    ],

    Para Swashbuckle Swagger você pode fazer o mesmo com IOperationFiltera abordagem ( exemplo @github )

    • 2

relate perguntas