传统ASPX Web应用能否添加MVC控制器实现API服务？

一、当前方案不可行的原因 #

你写的控制器是ASP.NET Core风格的API控制器（依赖Microsoft.AspNetCore.Mvc、继承ControllerBase），但你的项目是传统.NET Framework的ASP.NET Web Forms（.aspx页面），两个框架的运行环境、依赖体系完全不兼容，直接添加这类控制器无法被项目识别，自然无法通过URL触发断点。

二、适合传统Web Forms项目的API方案 #

针对你的场景，有两种可行方案，各有优劣：

方案1：添加.NET Framework版ASP.NET Web API控制器 #

这是最接近你想要的“MVC风格控制器”的方案，步骤如下：

1. 在Web Forms项目中安装Microsoft.AspNet.WebApi NuGet包
2. 添加Web API控制器（继承ApiController，而非ASP.NET Core的ControllerBase）
3. 在Global.asax中注册Web API路由

示例控制器代码：

Imports System.Web.Http

Public Class TestouilleController
    Inherits ApiController

    <HttpGet>
    Public Function GetCustomHeader() As IHttpActionResult
        Dim customHeader As String = Request.Headers.GetValues("Custom-Header")?.FirstOrDefault()
        If String.IsNullOrEmpty(customHeader) Then
            Return BadRequest("Custom header 'Custom-Header' is missing.")
        Else
            Return Ok("Received custom header: " & customHeader)
        End If
    End Function
End Class

在Global.asax的Application_Start方法中添加路由配置：

Imports System.Web.Http

Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ' 注册Web API路由
    GlobalConfiguration.Configure(AddressOf WebApiConfig.Register)
End Sub

' 新建WebApiConfig类
Public Class WebApiConfig
    Public Shared Sub Register(config As HttpConfiguration)
        ' 启用属性路由
        config.MapHttpAttributeRoutes()

        ' 配置默认路由
        config.Routes.MapHttpRoute(
            name:="DefaultApi",
            routeTemplate:="api/{controller}/{action}/{id}",
            defaults:=New With {.id = RouteParameter.Optional}
        )
    End Sub
End Class

配置完成后，访问路径为：https://localhost:myport/api/Testouille/GetCustomHeader

方案2：使用ASMX Web服务 #

这是传统的SOAP风格Web服务，优点是配置简单，无需额外路由，适合简单场景：

1. 右键项目 → 添加 → 新建项 → 选择“Web服务（ASMX）”
2. 在ASMX文件中编写服务方法

示例代码：

Imports System.Web.Services
Imports System.Web.Services.Protocols

<WebService(Namespace:="http://tempuri.org/")>
<WebServiceBinding(ConformsTo:=WsiProfiles.BasicProfile1_1)>
<Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()>
Public Class TestouilleService
    Inherits System.Web.Services.WebService

    <WebMethod>
    Public Function GetCustomHeader() As String
        Dim customHeader As String = Context.Request.Headers("Custom-Header")
        If String.IsNullOrEmpty(customHeader) Then
            Throw New Exception("Custom header 'Custom-Header' is missing.")
        Else
            Return "Received custom header: " & customHeader
        End If
    End Function
End Class

访问路径为：https://localhost:myport/TestouilleService.asmx/GetCustomHeader

三、方案选择建议 #

• 如果需要REST风格API、后续有扩展需求，优先选Web API控制器方案，它更符合现代API设计逻辑，灵活性更高。
• 如果只是简单的服务调用，不需要复杂的REST特性，ASMX配置更快捷，适合快速实现。

内容的提问来源于stack exchange，提问作者YannickIngenierie