使用属性XML注释作为Swagger中的参数描述

Question

我使用ASP.NET Core创建了一个Web API，并使用swagger来创建文档。我在API端点上使用XML注释来提供文档中的其他信息。招摇的配置是：

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);
        });

我的一个API端点及其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是一个单独的类，它是API端点所期望的参数的包装器。

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项目，然后单击“属性”。单击Build选项卡并导航到Output。确保选中XML文档文件。您可以保留默认文件路径。在我的情况下它的bin \ SwaggerDemoApi.XML

Answer 2

如果你有一个在不同项目中定义的模型类，那么你需要转到这个项目的Properties，并在Build/Output下检查“XML文档文件：”选项。然后你需要更新swagger配置文件添加。

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

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

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

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

到swagger配置文件。

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