我知道的最简单的方法是利用属性路由
例子
以一个包含 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 请求。
现在,在将托管在 IIS 中的 WebApi 项目中,您需要执行以下操作:
添加对您的类库的引用
我知道这可能是一个“duh”,但只是把它放在这里作为一种形式。您需要在 WebApi 项目中添加对 API 控制器类库的引用。
创建注册方法
无论是在App_Start\RouteConfig.cs
还是在 newApp_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 学习!