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参数就能正确地显示集合类型的属性了。

相关内容

热门资讯

记者揭秘!智星菠萝辅助(透视辅... 记者揭秘!智星菠萝辅助(透视辅助)拱趴大菠萝辅助神器,扑克教程(有挂细节);模式供您选择,了解更新找...
一分钟揭秘!约局吧能能开挂(透... 一分钟揭秘!约局吧能能开挂(透视辅助)hhpoker辅助靠谱,2024新版教程(有挂教学);约局吧能...
透视辅助!wepoker模拟器... 透视辅助!wepoker模拟器哪个好用(脚本)hhpoker辅助挂是真的,科技教程(有挂技巧);囊括...
透视代打!hhpkoer辅助器... 透视代打!hhpkoer辅助器视频(辅助挂)pokemmo脚本辅助,2024新版教程(有挂教程);风...
透视了解!约局吧德州真的有透视... 透视了解!约局吧德州真的有透视挂(透视脚本)德州局HHpoker透视脚本,必胜教程(有挂分析);亲,...
六分钟了解!wepoker挂底... 六分钟了解!wepoker挂底牌(透视)德普之星开辅助,详细教程(有挂解密);德普之星开辅助是一种具...
9分钟了解!wpk私人辅助(透... 9分钟了解!wpk私人辅助(透视)hhpoker德州透视,插件教程(有挂教学);风靡全球的特色经典游...
推荐一款!wepoker究竟有... 推荐一款!wepoker究竟有透视(脚本)哈糖大菠萝开挂,介绍教程(有挂技术);囊括全国各种wepo...
每日必备!wepoker有人用... 每日必备!wepoker有人用过(脚本)wpk有那种辅助,线上教程(有挂规律);wepoker有人用...
玩家必备教程!wejoker私... 玩家必备教程!wejoker私人辅助软件(脚本)哈糖大菠萝可以开挂,可靠技巧(有挂神器)申哈糖大菠萝...