将示例值添加到参数的 swagger UI

Question

.Net core 中是否有任何方法可以将示例值包含到 Swagger UI 中操作方法的参数中。响应/请求的示例值的显示方式相同。

似乎没有任何直接的方法，例如SwaggerRequestExample可以.Net core为参数显示示例值。

有人可以帮助我提供初步解决方案或任何可以开始的链接。

我正在寻找类似下面的输出。

这是模型对象

public class Vehicle
{
        public long Id { get; set; }
        public string VehicleName { get; set; }
        public int Price { get; set; }
}

这是帖子方法

 [HttpPost]
 public void Post(int id, [FromBody] Vehicle val)
 {

 }

这会将 ID 显示为参数，但车辆型号不会显示在参数列表中。我希望它显示为示例值。我还在启动文件中配置了以下内容 c.IncludeXmlComments(xmlPath);

Answer 1

3.0默认情况下，Swashbuckle 会以规范\xe2\x80\x94（正式称为规范）的版本生成并公开 Swagger JSON OpenAPI。为了支持向后兼容性，您可以选择以该2.0格式公开 JSON。此2.0格式对于当前支持 OpenAPI 版本的 Microsoft Power Apps 和 Microsoft Flow 等集成非常重要2.0。要选择该2.0格式，请SerializeAsV2在 Startup.Configure 中设置属性：

\n

   ...\n   // Enable middleware to serve generated Swagger as a JSON endpoint.\n    app.UseSwagger(c =>\n    {\n        c.SerializeAsV2 = true;\n    });\n  ...\n

\n

前

\n

{\n  "openapi": "3.0.1",\n  "info": {\n    "title": "SwaggerApplication",\n    "version": "1.0"\n  },...\n

\n

\n

后

\n

{\n  "swagger": "2.0",\n  "info": {\n    "title": "SwaggerApplication",\n    "version": "1.0"\n  }, ...\n

\n

\n