如何将 swagger 示例添加到 asp.net 内核中的字段？

Question

基于Swagger 文档，我必须能够为我的 class 字段添加一些示例，例如：

但我找不到任何方法将这些示例添加到我的课程中。

Answer 1

您可以启用XML 注释，然后使用<example>元素定义示例。 这是使用<example>的示例：

public class CompanyValidationResponse
{
    /// <example>1234</example>
    public int CompanyId { get; set; }

    /// <example>Damage, Inc</example>
    public string CompanyName { get; set; }
}

Answer 2

首先，您需要将 XML 文档添加到 class 中。 这是一个例子。

namespace WebApplication44
{
    /// <summary>
    /// Display Weather Forecast
    /// </summary>
    public class WeatherForecast
    {
        /// <summary>
        /// Date of the weather
        /// </summary>
        public DateTime Date { get; set; }

        /// <summary>
        /// Temperature in Degree Celesuis
        /// </summary>
        public int TemperatureC { get; set; }
        /// <summary>
        /// Temperature in Fahrenheit
        /// </summary>
        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
        /// <summary>
        /// Summary of the Weather. It can be "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
        /// </summary>
        public string? Summary { get; set; }
    }
}

接下来，您需要在 Visual Studio 的项目属性中启用Documentation File > Generate a File containing API documentation option - 无需更改位置。

最后，像这样修改swagger生成代码。

var xmlDoc = Path.ChangeExtension(Assembly.GetExecutingAssembly().Location, "xml");
builder.Services.AddSwaggerGen(options => options.IncludeXmlComments(xmlDoc, true));

然后您将能够看到像这样的 Open API 文档。