ASP.NETCoreAPI的HTTPPOST请求Swagger示例中声明的集合字段缺失。
创始人
2024-09-17 18:32:23
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参数就能正确地显示集合类型的属性了。

相关内容

热门资讯

安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
app安卓系统登录不了,解锁登... 最近是不是你也遇到了这样的烦恼:手机里那个心爱的APP,突然就登录不上了?别急,让我来帮你一步步排查...
安卓系统拦截短信在哪,安卓系统... 你是不是也遇到了这种情况:手机里突然冒出了很多垃圾短信,烦不胜烦?别急,今天就来教你怎么在安卓系统里...
安卓系统要维护多久,安卓系统维... 你有没有想过,你的安卓手机里那个陪伴你度过了无数日夜的安卓系统,它究竟要陪伴你多久呢?这个问题,估计...
windows官网系统多少钱 Windows官网系统价格一览:了解正版Windows的购买成本Windows 11官方价格解析微软...
安卓系统如何卸载app,轻松掌... 手机里的App越来越多,是不是感觉内存不够用了?别急,今天就来教你怎么轻松卸载安卓系统里的App,让...
怎么复制照片安卓系统,操作步骤... 亲爱的手机控们,是不是有时候想把自己的手机照片分享给朋友,或者备份到电脑上呢?别急,今天就来教你怎么...
安卓系统应用怎么重装,安卓应用... 手机里的安卓应用突然罢工了,是不是让你头疼不已?别急,今天就来手把手教你如何重装安卓系统应用,让你的...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...