Yi.Framework.AspNetCore.xml
29.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
<?xml version="1.0"?>
<doc>
<assembly>
<name>Yi.Framework.AspNetCore</name>
</assembly>
<members>
<member name="T:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.ApiInfoBuilderExtensions">
<summary>
提供API信息处理的应用程序构建器扩展方法
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.ApiInfoBuilderExtensions.UseApiInfoHandling(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
<summary>
使用Yi框架的API信息处理中间件
</summary>
<param name="builder">应用程序构建器实例</param>
<returns>配置后的应用程序构建器实例</returns>
<exception cref="T:System.ArgumentNullException">当builder参数为null时抛出</exception>
</member>
<member name="T:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerBuilderExtensions">
<summary>
Swagger构建器扩展类
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerBuilderExtensions.UseYiSwagger(Microsoft.AspNetCore.Builder.IApplicationBuilder,Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerConfiguration[])">
<summary>
配置并使用Yi框架的Swagger中间件
</summary>
<param name="app">应用程序构建器</param>
<param name="swaggerConfigs">Swagger配置模型数组</param>
<returns>应用程序构建器</returns>
</member>
<member name="T:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerConfiguration">
<summary>
Swagger配置模型
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerConfiguration.Url">
<summary>
Swagger JSON文档的URL
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerConfiguration.Name">
<summary>
Swagger文档的显示名称
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerConfiguration.#ctor(System.String)">
<summary>
使用默认URL创建Swagger配置
</summary>
<param name="name">文档显示名称</param>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Builder.SwaggerConfiguration.#ctor(System.String,System.String)">
<summary>
创建自定义Swagger配置
</summary>
<param name="url">Swagger JSON文档URL</param>
<param name="name">文档显示名称</param>
</member>
<member name="T:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Middlewares.ApiInfoMiddleware">
<summary>
API响应信息处理中间件
主要用于处理特定文件类型的响应头信息
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Middlewares.ApiInfoMiddleware.InvokeAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Http.RequestDelegate)">
<summary>
处理HTTP请求的中间件方法
</summary>
<param name="context">HTTP上下文</param>
<param name="next">请求处理委托</param>
<returns>异步任务</returns>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.AspNetCore.Middlewares.ApiInfoMiddleware.HandleFileDownloadResponse(Microsoft.AspNetCore.Http.HttpContext)">
<summary>
处理文件下载响应的响应头信息
</summary>
<param name="context">HTTP上下文</param>
</member>
<member name="T:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.SwaggerAddExtensions">
<summary>
Swagger生成器扩展类
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.SwaggerAddExtensions.AddYiSwaggerGen``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions})">
<summary>
添加Yi框架的Swagger生成器服务
</summary>
<typeparam name="TProgram">程序入口类型</typeparam>
<param name="services">服务集合</param>
<param name="setupAction">自定义配置动作</param>
<returns>服务集合</returns>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.SwaggerAddExtensions.ConfigureApiGroups(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions,System.Collections.Generic.IEnumerable{Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting})">
<summary>
配置API分组
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.SwaggerAddExtensions.ConfigureApiFilter(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions,System.Collections.Generic.IEnumerable{Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting})">
<summary>
配置API文档过滤器
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.SwaggerAddExtensions.IncludeXmlComments``1(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions)">
<summary>
包含XML注释文档
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.SwaggerAddExtensions.ConfigureJwtAuthentication(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions)">
<summary>
配置JWT认证
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.SwaggerAddExtensions.ConfigureCustomFilters(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions)">
<summary>
配置自定义过滤器
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.EnumSchemaFilter">
<summary>
Swagger文档枚举字段显示过滤器
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.EnumSchemaFilter.Apply(Microsoft.OpenApi.Models.OpenApiSchema,Swashbuckle.AspNetCore.SwaggerGen.SchemaFilterContext)">
<summary>
应用枚举架构过滤器
</summary>
<param name="schema">OpenAPI架构</param>
<param name="context">架构过滤器上下文</param>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.EnumSchemaFilter.GetEnumDescription(System.Enum)">
<summary>
获取枚举描述特性值
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.TenantHeaderOperationFilter">
<summary>
租户头部参数过滤器
</summary>
</member>
<member name="F:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.TenantHeaderOperationFilter.TenantHeaderKey">
<summary>
租户标识键名
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Microsoft.Extensions.DependencyInjection.TenantHeaderOperationFilter.Apply(Microsoft.OpenApi.Models.OpenApiOperation,Swashbuckle.AspNetCore.SwaggerGen.OperationFilterContext)">
<summary>
应用租户头部参数过滤器
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.Mvc.YiConventionalRouteBuilder">
<summary>
自定义路由构建器,用于生成API路由规则
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiConventionalRouteBuilder.#ctor(Microsoft.Extensions.Options.IOptions{Volo.Abp.AspNetCore.Mvc.Conventions.AbpConventionalControllerOptions})">
<summary>
构造函数
</summary>
<param name="options">ABP约定控制器配置选项</param>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiConventionalRouteBuilder.Build(System.String,System.String,Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel,System.String,Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting)">
<summary>
构建API路由
</summary>
<param name="rootPath">根路径</param>
<param name="controllerName">控制器名称</param>
<param name="action">Action模型</param>
<param name="httpMethod">HTTP方法</param>
<param name="configuration">控制器配置</param>
<returns>构建的路由URL</returns>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiConventionalRouteBuilder.BuildIdParameterRoute(System.String,Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel,Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting)">
<summary>
构建ID参数路由部分
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiConventionalRouteBuilder.BuildActionNameRoute(System.String,System.String,System.String,Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel,System.String,Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting)">
<summary>
构建Action名称路由部分
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.Mvc.YiServiceConvention">
<summary>
自定义服务约定实现,用于处理API路由和HTTP方法约束
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiServiceConvention.#ctor(Microsoft.Extensions.Options.IOptions{Volo.Abp.AspNetCore.Mvc.AbpAspNetCoreMvcOptions},Volo.Abp.AspNetCore.Mvc.Conventions.IConventionalRouteBuilder)">
<summary>
初始化服务约定的新实例
</summary>
<param name="options">ABP AspNetCore MVC 配置选项</param>
<param name="conventionalRouteBuilder">约定路由构建器</param>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiServiceConvention.ConfigureSelector(System.String,System.String,Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel,Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting)">
<summary>
配置选择器,处理路由和HTTP方法约束
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiServiceConvention.NormalizeSelectorRoutes(System.String,System.String,Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel,Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting)">
<summary>
规范化选择器路由
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiServiceConvention.GetOrCreateHttpMethod(Microsoft.AspNetCore.Mvc.ApplicationModels.SelectorModel,Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel,Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting)">
<summary>
获取或创建HTTP方法
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiServiceConvention.ConfigureRouteTemplate(Microsoft.AspNetCore.Mvc.ApplicationModels.SelectorModel,System.String,System.String,Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel,System.String,Volo.Abp.AspNetCore.Mvc.Conventions.ConventionalControllerSetting)">
<summary>
配置路由模板
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiServiceConvention.NormalizeAttributeRouteTemplate(Microsoft.AspNetCore.Mvc.ApplicationModels.SelectorModel,System.String)">
<summary>
规范化特性路由模板
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.Mvc.YiServiceConvention.EnsureHttpMethodConstraint(Microsoft.AspNetCore.Mvc.ApplicationModels.SelectorModel,System.String)">
<summary>
确保HTTP方法约束存在
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.RealIpHttpContextWebClientInfoProvider">
<summary>
真实IP地址提供程序,支持代理服务器场景
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.RealIpHttpContextWebClientInfoProvider.#ctor(Microsoft.Extensions.Logging.ILogger{Volo.Abp.AspNetCore.WebClientInfo.HttpContextWebClientInfoProvider},Microsoft.AspNetCore.Http.IHttpContextAccessor)">
<summary>
初始化真实IP地址提供程序的新实例
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.RealIpHttpContextWebClientInfoProvider.GetClientIpAddress">
<summary>
获取客户端IP地址,优先从X-Forwarded-For头部获取
</summary>
<returns>客户端IP地址</returns>
</member>
<member name="T:Yi.Framework.AspNetCore.RemoteServiceSuccessInfo">
<summary>
远程服务成功响应信息
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.RemoteServiceSuccessInfo.Code">
<summary>
获取或设置响应代码
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.RemoteServiceSuccessInfo.Message">
<summary>
获取或设置响应消息
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.RemoteServiceSuccessInfo.Details">
<summary>
获取或设置详细信息
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.RemoteServiceSuccessInfo.Data">
<summary>
获取或设置响应数据
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.RemoteServiceSuccessInfo.#ctor">
<summary>
初始化远程服务成功响应信息的新实例
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.RemoteServiceSuccessInfo.#ctor(System.String,System.String,System.String,System.Object)">
<summary>
使用指定参数初始化远程服务成功响应信息的新实例
</summary>
<param name="message">响应消息</param>
<param name="details">详细信息</param>
<param name="code">响应代码</param>
<param name="data">响应数据</param>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata">
<summary>
异常元数据
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata.StatusCode">
<summary>
状态码
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata.ErrorCode">
<summary>
错误码
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata.OriginErrorCode">
<summary>
错误码(没被复写过的 ErrorCode )
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata.Errors">
<summary>
错误对象(信息)
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata.Data">
<summary>
额外数据
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.Fiters.FriendlyExceptionFilter">
<summary>
友好异常拦截器
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Fiters.FriendlyExceptionFilter.OnExceptionAsync(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext)">
<summary>
异常拦截
</summary>
<param name="context"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Fiters.FriendlyExceptionFilter.GetExceptionMetadata(Microsoft.AspNetCore.Mvc.ActionContext)">
<summary>
获取异常元数据
</summary>
<param name="context"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter">
<summary>
规范化结构(请求成功)过滤器
</summary>
</member>
<member name="F:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter.FilterOrder">
<summary>
过滤器排序
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter.Order">
<summary>
排序属性
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter.OnActionExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate)">
<summary>
处理规范化结果
</summary>
<param name="context"></param>
<param name="next"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter.GetValidationMetadata(System.Object)">
<summary>
获取验证错误信息
</summary>
<param name="errors"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter.CheckVaildResult(Microsoft.AspNetCore.Mvc.IActionResult,System.Object@)">
<summary>
检查是否是有效的结果(可进行规范化的结果)
</summary>
<param name="result"></param>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter.CheckStatusCodeNonUnify(Microsoft.AspNetCore.Http.HttpContext,Yi.Framework.AspNetCore.UnifyResult.IUnifyResultProvider@)">
<summary>
检查短路状态码(>=400)是否进行规范化处理
</summary>
<param name="context"></param>
<param name="unifyResult"></param>
<returns>返回 true 跳过处理,否则进行规范化处理</returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Fiters.SucceededUnifyResultFilter.CheckSucceededNonUnify(System.Reflection.MethodInfo,System.Boolean)">
<summary>
检查请求成功是否进行规范化处理
</summary>
<param name="method"></param>
<param name="isWebRequest"></param>
<returns>返回 true 跳过处理,否则进行规范化处理</returns>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.IUnifyResultProvider">
<summary>
规范化结果提供器
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.IUnifyResultProvider.OnException(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext,Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata)">
<summary>
异常返回值
</summary>
<param name="context"></param>
<param name="metadata"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.IUnifyResultProvider.OnSucceeded(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext,System.Object)">
<summary>
成功返回值
</summary>
<param name="context"></param>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.IUnifyResultProvider.OnValidateFailed(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata)">
<summary>
验证失败返回值
</summary>
<param name="context"></param>
<param name="metadata"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.IUnifyResultProvider.OnResponseStatusCodes(Microsoft.AspNetCore.Http.HttpContext,System.Int32,Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions)">
<summary>
拦截返回状态码
</summary>
<param name="context"></param>
<param name="statusCode"></param>
<param name="unifyResultSettings"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.NonUnifyAttribute">
<summary>
禁止规范化处理
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.Providers.RESTfulResultProvider">
<summary>
RESTful 风格返回值
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Providers.RESTfulResultProvider.SetResponseStatusCodes(Microsoft.AspNetCore.Http.HttpContext,System.Int32,Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions)">
<summary>
设置响应状态码
</summary>
<param name="context"></param>
<param name="statusCode"></param>
<param name="unifyResultSettings"></param>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Providers.RESTfulResultProvider.OnException(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext,Yi.Framework.AspNetCore.UnifyResult.ExceptionMetadata)">
<summary>
异常返回值
</summary>
<param name="context"></param>
<param name="metadata"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Providers.RESTfulResultProvider.OnSucceeded(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext,System.Object)">
<summary>
成功返回值
</summary>
<param name="context"></param>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Providers.RESTfulResultProvider.OnValidateFailed(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata)">
<summary>
验证失败/业务异常返回值
</summary>
<param name="context"></param>
<param name="metadata"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Providers.RESTfulResultProvider.OnResponseStatusCodes(Microsoft.AspNetCore.Http.HttpContext,System.Int32,Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions)">
<summary>
特定状态码返回值
</summary>
<param name="context"></param>
<param name="statusCode"></param>
<param name="unifyResultSettings"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.Providers.RESTfulResultProvider.RESTfulResult(System.Int32,System.Boolean,System.Object,System.Object)">
<summary>
返回 RESTful 风格结果集
</summary>
<param name="statusCode"></param>
<param name="succeeded"></param>
<param name="data"></param>
<param name="errors"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.RESTfulResult`1">
<summary>
RESTful 风格结果集
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.RESTfulResult`1.StatusCode">
<summary>
状态码
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.RESTfulResult`1.Data">
<summary>
数据
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.RESTfulResult`1.Succeeded">
<summary>
执行成功
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.RESTfulResult`1.Errors">
<summary>
错误信息
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.RESTfulResult`1.Extras">
<summary>
附加数据
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.RESTfulResult`1.Timestamp">
<summary>
时间戳
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.UnifyResultExtensions">
<summary>
规范化接口
由于太多人反应,想兼容一套类似furion的返回情况,200状态码包一层更符合国内习惯,既然如此,不如直接搬过来
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions">
<summary>
规范化配置选项
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions.Return200StatusCodes">
<summary>
设置返回 200 状态码列表
<para>默认:401,403,如果设置为 null,则标识所有状态码都返回 200 </para>
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions.AdaptStatusCodes">
<summary>
适配(篡改)Http 状态码(只支持短路状态码,比如 401,403,500 等)
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions.SupportMvcController">
<summary>
是否支持 MVC 控制台规范化处理
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions.PostConfigure(Yi.Framework.AspNetCore.UnifyResult.UnifyResultSettingsOptions,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
选项后期配置
</summary>
<param name="options"></param>
<param name="configuration"></param>
</member>
<member name="T:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata">
<summary>
验证信息元数据
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.ValidationResult">
<summary>
验证结果
</summary>
<remarks>返回字典或字符串类型</remarks>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.Message">
<summary>
异常消息
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.ModelState">
<summary>
验证状态
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.ErrorCode">
<summary>
错误码
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.OriginErrorCode">
<summary>
错误码(没被复写过的 ErrorCode )
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.StatusCode">
<summary>
状态码
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.FirstErrorProperty">
<summary>
首个错误属性
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.FirstErrorMessage">
<summary>
首个错误消息
</summary>
</member>
<member name="P:Yi.Framework.AspNetCore.UnifyResult.ValidationMetadata.Data">
<summary>
额外数据
</summary>
</member>
<member name="T:Yi.Framework.AspNetCore.YiFrameworkAspNetCoreModule">
<summary>
Yi框架ASP.NET Core模块
</summary>
</member>
<member name="M:Yi.Framework.AspNetCore.YiFrameworkAspNetCoreModule.PostConfigureServices(Volo.Abp.Modularity.ServiceConfigurationContext)">
<summary>
配置服务后的处理
</summary>
</member>
</members>
</doc>