ASP.NETCoreAPI的HTTPPOST请求Swagger示例中声明的集合字段缺失。 _编程开发

ASP.NETCoreAPI的HTTPPOST请求Swagger示例中声明的集合字段缺失。

创始人

2024-09-17 18:31:38

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

上一篇：Asp.NetCoreAPICORS策略错误（+308状态码）

下一篇：ASP.NETCoreAPIDocker:Failedtoloadresource:theserverrespondedwithastatusof404(NotFound)

热门资讯

不能访问光猫的的管理页面光猫是现代家庭宽带网络的重要组成部分，它可以提供高速稳定的网络连接。但是，有时候我们会遇到不能访问光...

【NI Multisim 14... 目录序言一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...

Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限：此外...

银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介：银河麒麟高级服务器操作系统V10是针对企业级关键业务...

北信源内网安全管理卸载北信源内网安全管理是一款网络安全管理软件，主要用于保护内网安全。在日常使用过程中，卸载该软件是一种常...

安卓文字转语音tts没有声音安卓文字转语音TTS没有声音的问题在应用中比较常见，通常是由于一些设置或者代码逻辑问题导致的。本文将...

APK正在安装，但应用程序列表... 这个问题可能是由于以下原因导致的：应用程序安装的APK文件可能存在问题。设备上已经存在同名的应用程序...

ToDesk 远程工具安装及... 目录前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示文件传输设备链接 ...

AWSECS：访问外部网络时出... 如果您在AWS ECS中部署了应用程序，并且该应用程序需要访问外部网络，但是无法正常访问，可能是因为...

报告实验.pdfbase.tt... 这个错误通常是由于找不到字体文件或者文件路径不正确导致的。以下是一些解决方法：确认字体文件是否存在：...

ASP.NETCoreAPI的HTTPPOST请求Swagger示例中声明的集合字段缺失。

相关内容

热门资讯