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)

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

相关内容

热门资讯