在 Swagger 中使用属性 XML 注释作为参数说明

Question

我使用ASP.NETCore创建了一个Web API，并使用swagger创建留档。我使用APIendpoint上的XML注释在留档中提供附加信息。swagger配置是：

services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });

            // Set the comments path for the Swagger JSON and UI.
            var basePath = AppContext.BaseDirectory;
            var xmlPath = Path.Combine(basePath, "MyAPI.xml");
            c.IncludeXmlComments(xmlPath);
        });

我的一个APIendpoint及其XML注释是：

    /// <summary>
    /// Find an existing appointment using the visitor information: First name, last name, email, phone.
    /// </summary>
    /// <url>http://apiurl/api/appointments/appointmentsByVisitor</url>
    /// <param name="criteria">consists of one or more of:  Firstname, lastname, email, phone</param>
    /// <returns>Existing appointment data in an Appointment object or a business error.</returns>
    /// <response code="200">Returns the existing appointment event.</response>
    /// <response code="400">Returns if no parameters are specified.</response>            
    /// <response code="204">Returns if there's no matching appointment.</response>
    /// <response code="500">Returns if there's an unhandled exception.</response>
    [Authorize]
    [HttpGet("appointmentsByVisitor")]
    [ProducesResponseType(typeof(Appointment), 200)]
    [ProducesResponseType(typeof(BusinessError), 404)]
    public IActionResult AppointmentsByVisitor([FromQuery] VisitorSearchCriteria criteria) {}

VisitorSearchCriteria是一个单独的类，它是APIendpoint所需参数的包装器。

public class VisitorSearchCriteria
{
    /// <summary>
    /// Visitor first name.
    /// </summary>
    public string FirstName { get; set; }

    /// <summary>
    /// Visitor last name.
    /// </summary>
    public string LastName { get; set; }

    // several other properties....
}

此 API 终结点的 swagger 文档将 VisitorSearchCriteria 的所有属性显示为参数，但它不会选取 XML 注释。请参阅下面的屏幕截图。

如您所见，缺少参数的描述。如何告诉swagger使用外部类的XML注释来创建参数描述？

Answer 1

http://wmpratt.com/swagger-and-asp-net-web-api-part-1/

首先，在生成期间启用 XML 文档文件创建。在“解决方案资源管理器”中，右键单击 Web API 项目，然后单击“属性”。单击构建选项卡并导航到输出。确保选中 XML 文档文件。您可以保留默认文件路径。在我的例子中，它的bin\SwaggerDemoApi.XML

Answer 2

如果您在其他项目中定义了模型类，则需要转到此项目的属性，然后在“生成/输出”下检查“XML文档文件：”选项。然后你需要更新 swagger 配置文件添加。

c.IncludeXmlComments($@"{System.AppDomain.CurrentDomain.BaseDirectory}\YourProjectName.xml");

YourProjectName.xml应该包含xml格式的模型类字段的描述。

如果您想从不同的项目导入注释，则需要执行与上述相同的操作，添加

c.IncludeXmlComments($@"{System.AppDomain.CurrentDomain.BaseDirectory}\YourProjectName2.xml");

到招摇的配置文件。

请记住，每个项目都可以生成一个XML文件，您可以将所有这些文件的注释添加到您的swagger UI中。当您运行Swagger UI时，注释应出现在模型部分。