【发布时间】:2020-05-27 16:20:13
【问题描述】:
是否可以在 Swagger 页面上显示参数的 DataAnnotations,例如最小值和最大值?
我已经尝试将 ShowExtensions 和 ShowCommonExtension 设置为 true 或调用 ShowExtensions(),但并没有解决问题。 Range 属性和/或例如Swagger 页面上不显示字符串的 MaxLength(20)。
启动(代码 sn-p)
app.UseSwaggerUI(
options =>
{
options.ConfigObject = new ConfigObject
{
ShowCommonExtensions = true,
ShowExtensions = true
};
options.ConfigObject.AdditionalItems.Add("showCommonExtensions", true);
options.ShowExtensions();
框架/包
- .NET Core 3.1
- Swashbuckle.AspNetCore (5.4.1)
- Swashbuckle.AspNetCore.SwaggerGen (5.4.1)
控制器(代码 sn-p)
[HttpGet]
public IEnumerable<string> GetMethod([Required] [Range(1, 10)] int value)
{
Swagger 用户界面
【问题讨论】:
-
@HelderSepulveda 感谢您的回复。这个问题似乎与 OpenApi 规范的 V2 有关。提供的示例是使用 V2 而不是 OAS3,我正在使用的版本。
-
你能扩展一下“OpenApi 规范问题”吗?两者都有最大值和最小值的选项
-
@HelderSepulveda 请在 Swashbuckle.AspNetCore 的问题页面上查看更多详细信息 - #1683
-
能否展示一下你正在使用的swagger-ui的版本,这里有获取方法的说明:swagger.io/docs/open-source-tools/swagger-ui/usage/…
标签: asp.net-core swagger swagger-ui swashbuckle swashbuckle.aspnetcore