ABP官方文档翻译 5.1 Web API控制器
2017-06-14 23:14
579 查看
[b]ASP.NET Web API控制器[/b]
介绍
AbpApiController基类
本地化
其他
过滤器
审计日志
授权
反伪造过滤器
工作单元
结果包装和异常处理
结果缓存
校验
模型绑定器
介绍
ABP通过Abp.Web.Api nuget包集成到ASP.NET Web API控制器。你可以按照往常一样创建ASP.NET Web API控制器。依赖注入系统可以用于一般的ApiControllers。但是,建议继承AbpApiController,它提供了许多好处并且能够更好的与ABP集成。
AbpApiController基类
这有一个简单的继承自AbpApiController的api控制器:
本地化
AbpApiController定义了L方法,它使本地化更加简单。示例:
需要设置LocalizationSourceName才能使L方法正常使用。可以在基类api控制器里设置,这样就不用在每个api控制器里重复设置了。
其他
你也可以使用预注入的AbpSession,EventBus,PermissionManager,PermissionChecker,
SettingManager,FeatureChecker,LocalizationManager,Logger,CurrentUnitOfWork基础属性等。
过滤器
ABP为AspNet Web API定义了一些预生成的过滤器。他们默认添加到所有控制器的所有动作上。
审计日志
AbpApiAuditFilter用来集成审计日志系统。它默认记录所有动作的请求(如果审计没有被禁用)。你可以使用Audited和DisableAuditing特性来控制动作和控制器。
授权
你可以给控制器或动作使用AbpApiAuthorize特性来禁止未授权的用户使用你的控制器和动作。示例:
你可以为动作或控制器定义AllowAnoymous特性来禁用认证或授权。AbpApiController也定义了IsGranted方法作为在代码中检查权限的捷径。
参见授权文档了解更多。
反伪造过滤器
AbpAntiForgeryApiFilter用来自动保护ASP.NET Web API 的POST、PUT和DELETE请求动作免受CSRF/XSRF的攻击。参见CSRF文档了解更多。
工作单元
AbpApiUowFilter用来集成工作单元系统。它在动作执行之前自动开始一个新的工作单元,并在动作执行结束之后完成工作单元(如果没有异常抛出)。
你可以使用UnitOfWork特性来控制动作UOW的行为。你也可以使用启动配置来为所有的动改变默认的工作单元特性。
结果包装和异常处理
如果动作成功完成,ASP.NET Boilerplate默认不包装Web API动作。但是它处理和包装异常。如果需要,你可以给动作或控制器添加WrapResult/DontWrapResult特性。你可以在启动配置里(使用Configuration.Modules.AbpWebApi()...)改变默认的行为。参见AJAX文档了解更多关于结果包装的信息。
结果缓存
ABP为WebAPI请求的响应添加缓存控制header(no-cache,no-store)。因此,它阻止浏览器缓存相应,甚至GET请求也会被阻止缓存。可以在配置里禁用此功能。
校验
AbpApiValidationFilter自动检查ModelState.IsValid,如果校验失败则阻止动作的执行。还实现了输入DTO的校验,如在校验文档中所描述。
模型绑定器
AbpApiDateTimeBinder用来标准化DateTime(还有Nullable<DateTIme>)输入,使用Clock.Normalize方法。
返回主目录
介绍
AbpApiController基类
本地化
其他
过滤器
审计日志
授权
反伪造过滤器
工作单元
结果包装和异常处理
结果缓存
校验
模型绑定器
介绍
ABP通过Abp.Web.Api nuget包集成到ASP.NET Web API控制器。你可以按照往常一样创建ASP.NET Web API控制器。依赖注入系统可以用于一般的ApiControllers。但是,建议继承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,FeatureChecker,LocalizationManager,Logger,CurrentUnitOfWork基础属性等。
过滤器
ABP为AspNet Web API定义了一些预生成的过滤器。他们默认添加到所有控制器的所有动作上。
审计日志
AbpApiAuditFilter用来集成审计日志系统。它默认记录所有动作的请求(如果审计没有被禁用)。你可以使用Audited和DisableAuditing特性来控制动作和控制器。
授权
你可以给控制器或动作使用AbpApiAuthorize特性来禁止未授权的用户使用你的控制器和动作。示例:
public class UsersController : AbpApiController { [AbpApiAuthorize("MyPermissionName")] public UserDto Get(long id) { //... } }
你可以为动作或控制器定义AllowAnoymous特性来禁用认证或授权。AbpApiController也定义了IsGranted方法作为在代码中检查权限的捷径。
参见授权文档了解更多。
反伪造过滤器
AbpAntiForgeryApiFilter用来自动保护ASP.NET Web API 的POST、PUT和DELETE请求动作免受CSRF/XSRF的攻击。参见CSRF文档了解更多。
工作单元
AbpApiUowFilter用来集成工作单元系统。它在动作执行之前自动开始一个新的工作单元,并在动作执行结束之后完成工作单元(如果没有异常抛出)。
你可以使用UnitOfWork特性来控制动作UOW的行为。你也可以使用启动配置来为所有的动改变默认的工作单元特性。
结果包装和异常处理
如果动作成功完成,ASP.NET Boilerplate默认不包装Web API动作。但是它处理和包装异常。如果需要,你可以给动作或控制器添加WrapResult/DontWrapResult特性。你可以在启动配置里(使用Configuration.Modules.AbpWebApi()...)改变默认的行为。参见AJAX文档了解更多关于结果包装的信息。
结果缓存
ABP为WebAPI请求的响应添加缓存控制header(no-cache,no-store)。因此,它阻止浏览器缓存相应,甚至GET请求也会被阻止缓存。可以在配置里禁用此功能。
校验
AbpApiValidationFilter自动检查ModelState.IsValid,如果校验失败则阻止动作的执行。还实现了输入DTO的校验,如在校验文档中所描述。
模型绑定器
AbpApiDateTimeBinder用来标准化DateTime(还有Nullable<DateTIme>)输入,使用Clock.Normalize方法。
返回主目录
相关文章推荐
- ABP官方文档翻译 6.1.1 MVC控制器
- ABP官方文档翻译 6.6 Javascript API
- ABP官方文档翻译 3.3 仓储
- ABP官方文档翻译 10.1 ABP Nuget包
- ABP官方文档翻译 2.1 依赖注入
- ABP官方文档翻译 3.1 实体
- ABP官方文档翻译 3.7 领域事件(事件总线)
- ABP官方文档翻译 1.1 介绍
- ABP官方文档翻译 3.4 领域服务
- Sencha Touch 2 官方文档翻译之 Controllers(控制器学习指南)
- ABP官方文档翻译 4.1 应用服务
- Sencha Touch 2 官方文档翻译之 Controllers(控制器学习指南)
- ABP官方文档翻译 4.4 授权
- ABP官方文档翻译 6.1.3 异常处理
- ABP官方文档翻译 7.2 Hangfire集成
- ABP官方文档翻译 9.2 Entity Framework Core
- ABP官方文档翻译 1.2 N层架构
- Sencha Touch 2 官方文档翻译之 Controllers(控制器学习指南)
- ABP官方文档翻译 3.6 工作单元
- ABP官方文档翻译 4.5 特征管理