ASP.NETCoreAPI的HTTPPOST请求Swagger示例中声明的集合字段缺失。
创始人
2024-09-17 18:30:50
0

在ASP.NET Core API项目中,为了在Swagger UI界面上显示POST请求的Body参数,一般会使用Swagger的注解来添加相应的说明。例如下面的代码:

[HttpPost]
public async Task Create([FromBody] MyModel model)
{
   // ...
}

其中,MyModel代表请求Body中需要接收的Json对象。如果这个对象中包含集合类型的属性,例如List等,那么在Swagger UI界面上将无法正确显示该字段。解决方法是向List属性添加一个额外的注解,如下所示:

public class MyModel
{
   // ...
 
   [SwaggerSchema(ReadOnly = true, Type = "array", @Items = typeof(string))] // 添加的注解
   public List MyListProperty { get; set; }
}

其中,SwaggerSchema注解中的Type = "array"指定了该属性的类型为数组,@Items = typeof(string)指定了该数组元素的类型为字符串。此外,为了防止Swagger UI界面中该属性被误解为可编辑项,还可以设置ReadOnly = true

添加完这个注解后,重新编译并启动API项目,再次访问Swagger UI界面,POST请求的Body参数就能正确地显示集合类型的属性了。

相关内容

热门资讯

举措透视!wepoker游戏安... 举措透视!wepoker游戏安装教程,wepoker有辅助插件吗,第三方教程(有挂秘笈)-哔哩哔哩>...
发现透视"wepok... 发现透视"wepoker辅助工具好用吗"开挂(透视)辅助器(9分钟了解高科技教程)发现透视"wepo...
模块透视!hhpoker可以控... 【亲,hhpoker可以控制吗 这款游戏可以开挂的,确实是有挂的,很多玩家在这款hhpoker可以控...
实测透视"微扑克发牌... 实测透视"微扑克发牌机制详解"开挂(透视)辅助器(玩家亲测黑科技教程)实测透视"微扑克发牌机制详解"...
秘籍透视!wepoker可以透... >>您好:wepoker辅助器官方确实是有挂的,很多玩家在这款wepoker辅助器官方游戏中打牌都会...
正版透视"wepok... 正版透视"wepoker透视软件下载"开挂(透视)辅助软件(科技分享揭秘教程)正版透视"wepoke...
模块透视!pokemmo辅助官... wepoker模拟器哪个好用 无需打开直接搜索微信:136704302本司针对手游进行,选择我们的四...
曝光透视"微扑克辅助... 曝光透视"微扑克辅助期是干嘛的"开挂(透视)辅助工具(记者发布总结教程)曝光透视"微扑克辅助期是干嘛...
大纲透视!约局吧辅助脚本,aa... aapoker安装包怎么使用是一款可以让一直输的玩家,快速成为一个“必胜”的ai辅助神器,有需要的用...
必看透视"微扑克辅助... 必看透视"微扑克辅助器官网入口"开挂(透视)辅助脚本(今日公布必赢教程)必看透视"微扑克辅助器官网入...