将Web服务从asmx升级到webAPI

时间:2013-07-04 16:28:27

标签: c# asp.net asp.net-web-api

我正在构建一个目前使用传统.asmx网络服务的网络应用程序,我正在寻求将这些服务升级到WebAPI。我在网上环顾四周,但我正在寻找最简单/最快的方式来进行升级。 Web服务目前看起来像这样:

using System.Web.Services;

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[System.Web.Script.Services.ScriptService]
public class SomeWebServiceName : System.Web.Services.WebService
{
    SomeObject TheObject = new SomeObject;

    [WebMethod(EnableSession = true)]
    public string GetSomeData(string Param1, string Param2)
    {
         return TheObject.HandleRequest(Param1, Param2);
    }

    [WebMethod(EnableSession = true)]
    public string GetSomeMoreData(string ParamA)
    {
         return TheObject.HandleAnotherRequest(ParamA);
    }
}

在最简单的级别,他们实例化一个对象,然后Web服务的Web方法调用该对象的一些方法来处理请求。

在客户端上,我使用jquery和.ajax(),如下所示:

$.ajax({
    url: "../WebServices/SomeWebServiceName.asmx/GetSomeData",
    data: AjaxData, ....});

我想删除对.asmx的任何引用,并将整个应用程序升级到WebAPI。使用上面的代码,最简单的方法是什么?

3 个答案:

答案 0 :(得分:9)

正如@Venkat所说:“直接回答并不容易”;我的意思是,没有大量的手工编码;但做出一些假设我可以推荐实现一个控制器,如:

public class SomeWebServiceNameController : ApiController
{
    SomeObject TheObject = new SomeObject();

    public string GetSomeData(string Param1, string Param2)
    {
        return TheObject.HandleRequest(Param1, Param2);
    }

    public string GetSomeMoreData(string ParamA)
    {
        return TheObject.HandleAnotherRequest(ParamA);
    }

    [HttpPost]
    public string PostSomeMoreData([FromBody]string ParamA)
    {
        return TheObject.HandleAnotherRequest(ParamA);
    }
}

您还应该注册路线(通常在“WebApiConfig.cs”中):

public static void Register(HttpConfiguration config)
{
    config.Routes.MapHttpRoute(
        name: "NumberedParametersAPI",
        routeTemplate: "WebServices/{controller}/{action}/{Param1}/{Param2}"
    );
    config.Routes.MapHttpRoute(
        name: "CharacterizedParametersAPI",
        routeTemplate: "WebServices/{controller}/{action}/{ParamA}",
        defaults: new { ParamA = RouteParameter.Optional }
    );
}

我包含了最后一个方法“PostSomeMoreData”,以便与您在问题中指定的客户端调用(jQuery ajax方法调用)保持一致。但请记住,WebAPI的POST方法中的原始参数有点令人困惑。请阅读以下链接:

http://www.intstrings.com/ramivemula/articles/testing-asp-net-web-apiget-post-put-delete-using-fiddler/

http://yassershaikh.com/how-to-call-web-api-method-using-jquery-ajax-in-asp-net-mvc-4/

http://encosia.com/using-jquery-to-post-frombody-parameters-to-web-api/

答案 1 :(得分:3)

在下面创建一个类,将其放在Controllers / Api文件夹下,在App_Start下添加以下WebApiConfig

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute("DefaultApi", "api/{controller}/{action}/{id}",
            new { id = RouteParameter.Optional, action = RouteParameter.Optional });
    }
}

控制器编码

public class SomeWebServiceNameController : ApiController
{
    SomeObject TheObject = new SomeObject;

    [HttpGet]
    public string GetSomeData(string Param1, string Param2)
    {
         return TheObject.HandleRequest(Param1, Param2);
    }

    [HttpGet]
    public string GetSomeMoreData(string ParamA)
    {
         return TheObject.HandleAnotherRequest(ParamA);
    }
}

在application_start下的global.asax.cs中添加以下调用以注册路由:

WebApiConfig.Register(GlobalConfiguration.Configuration);

这是一个非常简单的解释,你可能想要返回一个对象而不是字符串,但是应该这样做。

答案 2 :(得分:1)

直接回答并不容易。我们首先需要验证您的应用程序架构是否真的支持基于HTTP / REST的调用。我的请求是在我们迁移到Web API之前需要清除的目的。

我不确定最简单的方法,但困难的方法是手动迁移。如果Web服务在asmx方法后面有类文件,或者您对服务有抽象,我们可以轻松地重用抽象来升级到Web API。

请查看以下链接,您可以更好地了解Web API: http://www.dotnet-tricks.com/Tutorial/webapi/JI2X050413-Difference-between-WCF-and-Web-API-and-WCF-REST-and-Web-Service.html