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

相关内容

热门资讯

iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
安卓系统怎么连不上carlif... 安卓系统无法连接CarLife的原因及解决方法随着智能手机的普及,CarLife这一车载互联功能为驾...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...
oppo手机安卓系统换成苹果系... OPPO手机安卓系统换成苹果系统:现实吗?如何操作?随着智能手机市场的不断发展,用户对于手机系统的需...
安卓平板改windows 系统... 你有没有想过,你的安卓平板电脑是不是也能变身成Windows系统的超级英雄呢?想象在同一个设备上,你...
安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
安卓系统上滑按键,便捷生活与高... 你有没有发现,现在手机屏幕越来越大,操作起来却越来越方便了呢?这都得归功于安卓系统上的那些神奇的上滑...
安卓系统连接耳机模式,蓝牙、有... 亲爱的手机控们,你们有没有遇到过这种情况:手机突然变成了“耳机模式”,明明耳机没插,声音却只从耳机孔...
安装了Anaconda之后找不... 在安装Anaconda后,如果找不到Jupyter Notebook,可以尝试以下解决方法:检查环境...
希沃系统怎么装安卓系统,解锁更... 亲爱的读者们,你是否也像我一样,对希沃一体机上的安卓系统充满了好奇呢?想象在教室里,你的希沃一体机不...