如何在 API 端点上添加后缀 .NET Core

Question

有没有办法在所有端点路由上自动添加后缀，例如 .json。

v1/users.json
v1/users/{id}.json

所以到目前为止我尝试过的是我创建了一个 BaseController ，它看起来像这样

[ApiController]
[Route("v1/[controller].json")]
public class BaseController : ControllerBase
{
}

，但每次我将它用于我的控制器时，它看起来像这样

v1/users.json
v1/users.json/{id}

Answer 1

您可以将额外的路由添加到实际端点而不是控制器

[ApiController]
[Route("v1/[controller]")]
public class BaseController : ControllerBase
{
    [HttpGet(".json")]
    public IActionResult Get()
    {
    
    }
    
    // Without Route Parameters
    [HttpGet("{id}.json")]
    public IActionResult Get([FromRoute] int id)
    {
          ...
    }

    // With Route and Query Parameters
    [HttpGet("{id}.json/friend")]
    public IActionResult Get([FromRoute]int id,[FromQuery] string friendName)
    {
          ...
    }

    // With Route and Query Parameters and Body
    [HttpPost("{id}.json/friends")]
    public IActionResult Get([FromRoute]int id,[FromQuery] string message, [FromBody]IFilter filter)
    {
          ...
    }
}

Answer 2

您可以使用 URL 重写中间件来接受带有 .json 的 URL，然后将其删除。因此，类似：

/api/users/123/picture.json?query=123

将变为：

/api/users/123/picture?query=123

您可以通过将以下代码添加到启动的 Configure 方法中来完成此操作：

var rewriteOptions = new RewriteOptions()
    .AddRewrite(@"^(.*?)(?:\.json)(\?.*)?$", "$1$2");
app.UseRewriter(rewriteOptions);

请参阅文档 了解更多信息。

注意：如果您使用 Url.Action(...) 等在代码中生成 URL，则它不会包含 .json。重写仅影响传入请求。