将示例值添加到 swagger UI 参数

Question

.Net 核心中是否有任何方法可以将示例值包含到 Swagger 中的操作方法的参数中 UI。 response/request.

示例值的显示方式相同

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

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

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

这是模型对象

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

这是post方法

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

 }

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

Answer 1

默认情况下，Swashbuckle 在规范的 3.0 版本中生成并公开 Swagger JSON——正式称为 OpenAPI 规范。为了支持向后兼容性，您可以选择以 2.0 格式公开 JSON。这种 2.0 格式对于目前支持 OpenAPI 版本 2.0 的 Microsoft Power Apps 和 Microsoft Flow 等集成很重要。要选择 2.0 格式，请在 Startup.Configure:

中设置 SerializeAsV2 属性

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

之前

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

之后

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

将示例值添加到 swagger UI 参数

Add example value to swagger UI for parameters

.net-core

swagger

asp.net-core-webapi

swagger-ui