将WebApi控制器从库托管到IIS

时间:2016-07-01 03:34:08

标签: c# asp.net iis asp.net-web-api self-host-webapi

我在类库中有一些WebApi控制器,我想在IIS中托管它们。我知道控制台应用程序或Windows服务中的Self-Hosting解决方案,但这只适合本地使用。我如何解析Asp.Net Web / WebApi应用程序中的控制器程序集,它实际上是IIS中托管的理想选择?

我正在寻找类似这种方法的东西,只有不同的托管方案: http://www.strathweb.com/2012/06/using-controllers-from-an-external-assembly-in-asp-net-web-api

1 个答案:

答案 0 :(得分:1)

我知道这样做的最简单方法是利用Attribute Routing

实施例

以一个包含ApiController的示例类库为例。使用属性路由,我们可以使用路径装饰类。

//Inside API controller class library
[RoutePrefix("Persons")]
public class PersonController : ApiController
{
    [Route("")]
    public List<Person> GetAll()
    {
        List<Person> results = new List<Person>();

        try
        {
            //TODO: Call Data Access Layer
            //FORNOW: Mock up some data
            results.Add(new Person() { Name = "Ryan C" });
            results.Add(new Person() { Name = "Siavash R" });
        }
        catch
        {
            //TODO: Handle error
        }

        return results;
    }
}

上述代码会在正确路由后响应/Persons的HTTP请求。

现在,您的WebApi项目将在IIS中托管,您需要执行以下操作:

添加对类库的引用

我知道这可能是'呃',但只是把它作为一种形式。您需要在WebApi项目中添加对API Controller类库的引用。

创建注册方法

App_Start\RouteConfig.cs或新App_Start\WebApiConfig.cs中,您拨打MapHttpAttributeRoutes();,就像这样:

//Inside App_Start\WebApiConfig.cs
public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Map all Web API routes
        config.MapHttpAttributeRoutes();
    }
}

ASP.NET框架非常智能,可以搜索任何引用的程序集并查找公共的ApiController派生类,在本例中是为属性路由修饰的类。

在Global.asax

中调用注册方法

最后一步是在Global.asax文件中实际调用注册方法:

//Inside Global.asax
public class WebApiApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        GlobalConfiguration.Configure(WebApiConfig.Register);
    }
}

在那之后,你应该好好去!我在本地测试它,构建一个完整的例子,它工作得很好。如果需要,我可以将我的示例项目发布到github,但上面的代码是关键点。

拨打http://localhost:xxxx/Persons/致电:

<ArrayOfPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ryancdotnet.WebApiClassLib.Model">
  <Person>
    <Name>Ryan C</Name>
  </Person>
  <Person>
    <Name>Siavash R</Name>
  </Person>
</ArrayOfPerson>

作为参考,如果您需要它,我的ApiController类库使用这些Nuget包。我不确定哪些是完全必要的,但这对于类库来说已经足够了。

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Microsoft.AspNet.WebApi.Client" version="5.2.3" targetFramework="net46" />
  <package id="Microsoft.AspNet.WebApi.Core" version="5.2.3" targetFramework="net46" />
  <package id="Microsoft.Bcl" version="1.1.10" targetFramework="net46" />
  <package id="Microsoft.Bcl.Build" version="1.0.14" targetFramework="net46" />
  <package id="Microsoft.Net.Http" version="2.2.29" targetFramework="net46" />
  <package id="Newtonsoft.Json" version="6.0.4" targetFramework="net46" />
  <package id="System.Web.Http.Common" version="4.0.20126.16343" targetFramework="net46" />
</packages>

快乐的API!