如何在 ASP.NET Core 启动时定义 Rest API 的路由？

Question

我知道如何使用属性定义路线，例如：

    [Route("api/v1/[controller]")]
    [ApiController]
    public class OTGController
    {
        [HttpGet("UpdateData")]
        public void UpdateData()
        {
            // to do...
        }
    }

但这不是很容易使用，我需要在添加新控制器时随时配置它。

首先，控制器的路由总是：“api/v1/[controller]”。我不想在每个控制器中都配置它。

其次，UpdateData 的路由是“UpdateData”。他们是一样的。我想这样定义它：

        [HttpGet]
        public void UpdateData()
        {
            // to do...
        }

如果我将路由留空，我希望它使用方法名称UpdateData 作为路由。这与默认行为不同。 如果不为空，我希望它使用定义的路由。

我想要我的最终代码：

    [ApiController]
    public class OTGController
    {
        [HttpGet]
        public void UpdateData()
        {
            // to do...
        }
    }

这个类中没有定义路由，应该按照我在启动时配置的规则成功生成路由。 怎么样？

Answer 1

解决方案 1：

您可以覆盖默认的EndpointMiddleware 中间件。更新 Startup 类上的函数 Configure(IApplicationBuilder app, IWebHostEnvironment env)。

...
app.UseEndpoints(endpoints =>
{
    endpoints.MapControllerRoute(
        "Default",
        "api/v1/{controller}/{action=UpdateData}"
    );
});
...

警告：您需要将 ApiControllerAttribute 删除到您的 Api 控制器。带有ApiControllerAttribute 注释的控制器上的操作方法必须是属性路由。

解决方案 2：

您始终可以创建 API 基控制器类。

[ApiController]
[Route("api/v1/[controller]")]
public class ApiControllerBase : ControllerBase
{
    [HttpGet("")]
    public virtual IActionResult UpdateData()
    {
        return NoContent();
    }
}

public class OTGController : ApiControllerBase
{
    public override IActionResult UpdateData()
    {
        return Ok("Updated!");
    }
}

解决方案 3：

EndpointMiddleware配置：

...
app.UseEndpoints(endpoints =>
{
    endpoints.MapControllerRoute(
        "Default",
        "api/v1/{controller}/{action=UpdateData}"
    );

    endpoints.MapControllers();
});
...

控制器：

[ApiController]
[Route("api/v1/[controller]")]
public class ApiControllerBase : ControllerBase
{
}

public class OTGController : ApiControllerBase
{
    public IActionResult UpdateData()
    {
        return Ok("Updated!");
    }
}