ASP.NET Aries 高级开发教程:如何写WebAPI接口

时间:2023-03-10 06:00:17
ASP.NET Aries 高级开发教程:如何写WebAPI接口

前提:

最近,有不少同学又问到,Aries里如何提供WebAPI接口?

针对这个问题,今天给顺路写个教程,其实呢,很简单的。

方式一:直接用WebService提供接口。

用这种方式,直接添加接口就可以了,Aries只是默认处理了.html后缀的请求。对于WS的asmx后缀是没有影响的,所以传统怎么添加就怎么添加。

方式二:单独用Taurus.MVC写一个接口项目。

用这种方式,就是把接口独立成一个项目,然后通过IIS部署成子应用程序就可以了。

只是部署成子应用程序的时候,需要注意一下子目录和根目录的web.config,出现重复的只能留根目录的那个。

(一般都会建议用户用这种方式,好处是可以在IIS里学会一下怎么部署子应用程序。)

方式三:在Aries引入Taurus.MVC即可。

这个方式,其实也很简单,下面介绍一下简单的部署:

1、引用Taurus.MVC用于写WebAPI:

在Web.UI项目添加引用Taurus.Core.dll(可以在Nuget上引用,也可以引用源码项目再引用项目)

2、配置Taurus.MVC的两个必备项:

A、在HttpModule中添加URL拦截。

//这是原来有的:
<add name="Aries.Core" type="Aries.Core.UrlRewrite,Aries.Core" />
//这是新添加的:
<add name="Taurus.Core" type="Taurus.Core.UrlRewrite,Taurus.Core"/>

B、在AppSetting中设置路径模式:

<!--配置模式【值为0,1或2】[默认为1]
值为0:匹配{Action}/{Para}
值为1:匹配{Controller}/{Action}/{Para}
值为2:匹配{Module}/{Controller}/{Action}/{Para}-->
<add key="Taurus.RouteMode" value=""/>

C、在AppSetting中设置接口代码所在的项目:

<!--指定控制器所在的项目(Dll)名称(可改,项目编绎的dll叫什么名就写什么)
<add key="Taurus.Controllers" value="Taurus.Controllers"/>-->

如果是用Nuget上引用的,默认都会有上面的两个,其它默认生的,可以注释掉。

3、开始写应用接口代码:

接口代码写在哪里呢?放在哪个项目都可以,只要上面C点的配置指向就可以了,如果接口代码分散在多个项目中,配置的value可以用“逗号”分隔。

按Taurus.MVC的方式写接口,继承自Taurus.Core.Controller即可:

如:

  /// <summary>
/// API 接口
/// </summary>
public class APIController : Taurus.Core.Controller
{
public void Hello()
{
Write("hello Controllers.API");
}
}

接口访问:http://.../api/hello

总结说明:

Aries中默认处理的是.html后缀。

Taurus默认处理的是无后缀。

所以两者并无冲突,直接引用,加配置就可以了,没你想的复杂。