c# - 一个 cs 文件中的多个 api Controller 类

Question

问题

是否可以在一个文件中包含多个 Controller ？

示例

位于 Controllers 文件夹中的 Controller 文件 TestController.cs:

TestController.cs

[RoutePrefix("api/v2")]
public class TestController : ApiController
{
     // action methods here...
}

[RoutePrefix("api/v1")]
public class OldTestController " ApiController
{
    // all action methods return an error stating that 
    // the user should update their client to be compatible with 
    // verison 2 of the API.
}

• GET api/v2/Test 将返回数据。
• GET api/v1/Test 将返回错误信息。

描述

我制作了我的 Rest API 的第 2 版，其中包括对旧移动应用程序的重大更改。

我希望旧路由向用户显示 json 错误消息以更新他们的移动应用。

我怎样才能做到这一点？

Answer 1

一个文件中可以有多少个 Controller 没有限制。

要将 Controller 标记为过时，一种选择是实现 ActionFilter 以返回您想要的错误。

public class ObsoleteApiAttribute : System.Web.Http.Filters.ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        var response = actionContext.Request.CreateResponse(System.Net.HttpStatusCode.BadRequest, "Update your app");
        actionContext.Response = response;
    }
}

然后只需应用到您想要返回错误的 Controller 或方法。

[ObsoleteApi]
[RoutePrefix("api/v1")]
public class OldTestController : ApiController
{
    ...
}