Yi.Framework.AspNetCore
提供API信息处理的应用程序构建器扩展方法
使用Yi框架的API信息处理中间件
应用程序构建器实例
配置后的应用程序构建器实例
当builder参数为null时抛出
Swagger构建器扩展类
配置并使用Yi框架的Swagger中间件
应用程序构建器
Swagger配置模型数组
应用程序构建器
Swagger配置模型
Swagger JSON文档的URL
Swagger文档的显示名称
使用默认URL创建Swagger配置
文档显示名称
创建自定义Swagger配置
Swagger JSON文档URL
文档显示名称
API响应信息处理中间件
主要用于处理特定文件类型的响应头信息
处理HTTP请求的中间件方法
HTTP上下文
请求处理委托
异步任务
处理文件下载响应的响应头信息
HTTP上下文
Swagger生成器扩展类
添加Yi框架的Swagger生成器服务
程序入口类型
服务集合
自定义配置动作
服务集合
配置API分组
配置API文档过滤器
包含XML注释文档
配置JWT认证
配置自定义过滤器
Swagger文档枚举字段显示过滤器
应用枚举架构过滤器
OpenAPI架构
架构过滤器上下文
获取枚举描述特性值
租户头部参数过滤器
租户标识键名
应用租户头部参数过滤器
自定义路由构建器,用于生成API路由规则
构造函数
ABP约定控制器配置选项
构建API路由
根路径
控制器名称
Action模型
HTTP方法
控制器配置
构建的路由URL
构建ID参数路由部分
构建Action名称路由部分
自定义服务约定实现,用于处理API路由和HTTP方法约束
初始化服务约定的新实例
ABP AspNetCore MVC 配置选项
约定路由构建器
配置选择器,处理路由和HTTP方法约束
规范化选择器路由
获取或创建HTTP方法
配置路由模板
规范化特性路由模板
确保HTTP方法约束存在
真实IP地址提供程序,支持代理服务器场景
初始化真实IP地址提供程序的新实例
获取客户端IP地址,优先从X-Forwarded-For头部获取
客户端IP地址
远程服务成功响应信息
获取或设置响应代码
获取或设置响应消息
获取或设置详细信息
获取或设置响应数据
初始化远程服务成功响应信息的新实例
使用指定参数初始化远程服务成功响应信息的新实例
响应消息
详细信息
响应代码
响应数据
异常元数据
状态码
错误码
错误码(没被复写过的 ErrorCode )
错误对象(信息)
额外数据
友好异常拦截器
异常拦截
获取异常元数据
规范化结构(请求成功)过滤器
过滤器排序
排序属性
处理规范化结果
获取验证错误信息
检查是否是有效的结果(可进行规范化的结果)
检查短路状态码(>=400)是否进行规范化处理
返回 true 跳过处理,否则进行规范化处理
检查请求成功是否进行规范化处理
返回 true 跳过处理,否则进行规范化处理
规范化结果提供器
异常返回值
成功返回值
验证失败返回值
拦截返回状态码
禁止规范化处理
RESTful 风格返回值
设置响应状态码
异常返回值
成功返回值
验证失败/业务异常返回值
特定状态码返回值
返回 RESTful 风格结果集
RESTful 风格结果集
状态码
数据
执行成功
错误信息
附加数据
时间戳
规范化接口
由于太多人反应,想兼容一套类似furion的返回情况,200状态码包一层更符合国内习惯,既然如此,不如直接搬过来
规范化配置选项
设置返回 200 状态码列表
默认:401,403,如果设置为 null,则标识所有状态码都返回 200
适配(篡改)Http 状态码(只支持短路状态码,比如 401,403,500 等)
是否支持 MVC 控制台规范化处理
选项后期配置
验证信息元数据
验证结果
返回字典或字符串类型
异常消息
验证状态
错误码
错误码(没被复写过的 ErrorCode )
状态码
首个错误属性
首个错误消息
额外数据
Yi框架ASP.NET Core模块
配置服务后的处理