.NET 6 Swagger guid 生成“https://localhost:5001/api/sth/%7Bid%7D”

Question

我对 Swagger 有意见。

当我尝试将查询作为参数传递时，它的 URL 格式不正确-> https://localhost:5001/api/sport/%7Bid%7D

预期的结果是这样的： https://localhost:5001/api/sport/00000000-0000-0000-0000-000000000001 调用时到达了我的端点。

我有这个路由参数，我的对象看起来像这样：

    [HttpGet("{id:guid}")]
    [ProducesResponseType(typeof(SportEventResource),(int)HttpStatusCode.OK)]
    [SwaggerOperation(
        Summary = "Gets a new Sport event",
        Description = "Gets a new Sport event with its associative Markets and Selections",
        OperationId = "sportEvent.get",
        Tags = new[] { "SportEventEndpoints" })]
    public async Task<ActionResult<SportEventResource>> Get([FromRoute]GetSportEvent query)
    {...
    // The parameter looks like this...
    public class GetSportEvent : IQuery<Sport>
    {
        public Guid Id { get; set; }
    }
   // The rest is basically the auto generated values.
   // Rest of Setup => Program.cs
   builder.Services.AddSwaggerGen(opt =>
   {
      opt.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
      opt.EnableAnnotations();
   });

   
   if (app.Environment.IsDevelopment())
   {
      app.UseSwagger();
      app.UseSwaggerUI();
   }

   

这是我的 Swagger 的生成方式： 每当我按下执行时，我都会收到一个未找到的错误，并且我的端点永远不会被调用。 查看网络选项卡，我可以看到格式错误的 url：https://localhost:5001/api/sport/%7Bid%7D

Answer 1

%7Bid%7D url 解码为{id}，这使得“有意义”，您要求一个具有 Id 属性的对象。这是一种 json 式的做法。

解决此问题的简单方法是删除您的类并直接绑定 Guid。

[HttpGet("{id:guid}")]
public async Task<ActionResult<SportEventResource>> Get([FromRoute] Guid id)
{

该参数需要称为id，因为这是您在模板中拥有的 ("{id:guid}")。

Answer 2

这似乎是由不匹配的字母大小写引起的 - URI 模板中的参数/api/sport/{id} 命名为id（小写），但方法参数命名为Id（大写“I”）。

尝试将public Guid Id 更改为public Guid id

或

将[HttpGet("{id:guid}")] 更改为[HttpGet("{Id:guid}")]。