Swagger/OpenApi Model 示例值

Question

我試圖在我的 Swagger/OpenApi 中插入我自己的值，目前在 Model 示例值中我有以下值：

期望的情況如下圖所示：

我研究了它並嘗試了多種方法來實現這一點，例如我嘗試像這樣添加 XMLComments：

但是，這不起作用。 然后我嘗試使用提供此功能的 MapType function，我使用以下代碼完成了此操作：

c.MapType<Student>(() => new Schema()
                    {
                        example = new Student()
                        {
                            StudentName = "John Doe",
                            Age = 28
                        }
                    });

但是，當我以這種方式嘗試時，我得到以下結果：

有任何解決這個問題的方法嗎？

Answer 1

使用 NuGet Package Swashbuckle.AspNetCore.Filters如下：

添加您的默認 model （您打算以大搖大擺的方式顯示的默認值）如下：

public class StudentDtoDefault : IExamplesProvider<StudentDto>
{
   public StudentDto GetExamples()
    {
        return new StudentDto
        {
             StudentName = "John Doe",
             Age = 28
        };
    }
}

請注意，它是從IExamplesProvider<StudentDto>繼承的，其中StudentDto是主要的 model，我將其發送到 API controller。

這就是我們應該如何將它應用於我們的 controller 操作：

    [SwaggerRequestExample(typeof(StudentDto), typeof(StudentDtoDefault))]
    [HttpPost]
    public ActionResult Post([FromBody] StudentDto student)
    {
        ...
    }

在此處輸入代碼

Answer 2

我使用並解決了我的問題的方法如下：

在 Swagger 配置中：

.EnableSwagger("/swagger", c=> {
    c.SchemaFilter<SwaggerExamples>();
})

然后在 SwaggerExamples.cs 中：

using Swashbuckle.Swagger;

public class SwaggerExamples : ISchemaFilter 
{
   public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
        {
           if(type == typeof(Student))
               {
                   schema.example = new Student
                   {
                       StudentName = "John",
                       Age = 28
                   };
               }
        }
}

這導致了我原始問題中圖像中顯示的預期值。