ABP文档 Web Api 控制器
|
文档目录
本节内容：
简介 通过Abp.Web.Api的nuget包，把ABP集成到Asp.net Web Api 控制器里。你可以像之前做的一样创建平常的Asp.net Web Api控制器，依赖注入会很好地为这些平常的ApiController工作，但你要把你的控制器继承于AbpApiController，它提供了许多好处和更好地集成到ABP。
AbpApiController基类 这是一个简单的继承于AbpApiController的api控制器： public class UsersController : AbpApiController
{
}
本地化 AbpApiController定义了L方法，使得本地化变得更容易，如： public class UsersController : AbpApiController
{
public UsersController()
{
LocalizationSourceName = "MySourceName";
}
public UserDto Get(long id)
{
var helloWorldText = L("HelloWorld");
//...
}
}
你先要设置LocalizationSourceName，L方法才能正确工作，你可以在你自己的基api控制器类里设置它，这样就不用再为每个api控制器重复设置。
其它 你可以使用预先注入的AbpSession、EventBus、PermissionManager、PermissionChecker、SettingManager、FeatureManager、FeatureChecker、LocalizationManager、Logger、CurrentUnitOfWork等基属性。
过滤 ABP为所有的Asp.net Web Api预置了一些过滤，它们被默认地添加到所有控制器的所有Action里。
审计日志 AbpApiAuditFilter用来集成到审计日志系统，它在默认情况下记录所有对所有Action请求（如果审计没有被禁用），你可以用Audited和DisableAuditing特性控制Action和控制器的审计日志。
授权 你为你的api控制器或Action使用AbpApiAuthorize特性，阻止未授权用户访问它们，例如： public class UsersController : AbpApiController
{
[AbpApiAuthorize("MyPermissionName")]
public UserDto Get(long id)
{
//...
}
}
你可以为Action或控制器定义AllowAnonymous特性，废止认证/授权。AbpApiController也定义了一个在定义里检查许可的快捷方法IsGranted。 更多信息查看授权文档。
防伪造过滤 AbpAntiForgeryApiFilter自动保护Asp.net Web Api的Action（包括动态Web Api）来自CSRF/XSRF的POST、PUT和DELETE请求攻击。更多信息查看CSRF文档。
工作单元 AbpApiUowFilter用来整合到工作单元系统，在一个Action执行前自动开始一个工作单元，并在Action执行结束后完成工作单元（如果没有异常抛出）。 你可为一个Action使用UnitOfWork特性，控制它的工作单元行为，你也可以在启动配置里为所有Action修改默认的工作单元特性。
结果包装和异常处理 当Web Api的Action成功执行后，ABP不会默认地自动包装它，但ABP会处理并包装异常，如有需要，你可以给Action和控制器添加WrapResult/DontWrapResult，你可以从启动配置里修改这个默认行为（使用Configuration.Modules.AbpWebApi()....）。关于结果包装的更多信息，查看AJAX文档。
结果缓存 ABP为Web Api请求响应里添加了Cache-Control头（no-cache，no-store），因此，它甚至会阻止浏览器对GET请求响应的缓存，不过可以通过配置这个行为。
验证 AbpApiValidationFilter自动检查ModelState.IsValid并在检测到非法时阻止Action执行。实现输入DTO的验证在验证文档里进行了描述。
模块绑定器 AbpApiDateTimeBinder用来标准化通过Clock.Normalize方法输入的DateTime（和Nullable<DateTime>）。 （编辑：宁德站长网） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |
