ASP.NETCoreOData接口中使用[FromOdataUri]参数的Swagger
创始人
2024-09-18 04:30:44
0

在ASP.NET Core OData中使用[FromOdataUri]特性时,Swagger UI在默认情况下不能正确生成参数示例。为了解决这个问题,需要在启用Swagger的过程中使用一个中间件并附加一个处理器来解析参数。下面是一个示例代码:

  1. 添加Swagger中间件:

public void Configure(IApplicationBuilder app, IHostingEnvironment env) { ... app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "OData API V1"); c.OperationFilter(); }); ... }

  1. 定义ODataOperationFilter处理器:

public class ODataOperationFilter : IOperationFilter { private readonly ODataSwaggerProvider _swaggerProvider;

public ODataOperationFilter(ODataSwaggerProvider swaggerProvider) { _swaggerProvider = swaggerProvider; }

public void Apply(Operation operation, OperationFilterContext context) { foreach (var parameter in operation.Parameters) { if (parameter.In == "query" && parameter.Extensions.ContainsKey("x-ms-odata")) { var odataParam = parameter.Extensions["x-ms-odata"].ToString(); var schema = _swaggerProvider.GetSwaggerSchema(odataParam); if (schema != null) { parameter.Schema = schema; parameter.Extensions.Remove("x-ms-odata"); } } } } }

  1. 在Startup.cs文件中注册处理器:

services.AddSingleton(); services.AddSwaggerGen(c => { c.DescribeAllEnumsAsStrings(); c.SwaggerDoc("v1", new Info { Title = "OData API", Version = "v1" }); c.OperationFilter(); });

通过这种方法,可以使用[FromOdataUri]特性编写ASP.NET Core OData接口,并使用Swagger正确生成参数示例。

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...