asp.net - Swashbuckle Swagger UI 不显示参数说明

Question

软件包版本 6.0.0-beta902

例子 :

public class TestModel
{
    /// <summary>
    /// This is description of Name
    /// </summary>
    public string Name { get; set; }
}

public IActionResult HelloWorld(TestModel model)
{
    return Content("hello " + model.Name);
}

为什么 Swagger UI 不显示 Name 参数描述？

Answer 1

这通常是由缺少配置引起的，请确保您的 IncludeXmlComments 具有正确的 XML 文档路径。

这是一种在配置中包含所有 XML 文档的方法:

    public void ConfigureServices(IServiceCollection services)
    {
        // Add Swashbuckle
        services.AddSwaggerGen(options =>
        {
            options.DescribeAllEnumsAsStrings();
            options.SingleApiVersion(new Swashbuckle.Swagger.Model.Info()
            {
                Title = "My API",
                Version = "v1",
                Description = "My API",
                TermsOfService = "Terms Of Service"
            });

            //Set the comments path for the swagger json and ui.
            var basePath = PlatformServices.Default.Application.ApplicationBasePath;
            foreach (var name in Directory.GetFiles(basePath, "*.XML", SearchOption.AllDirectories))
            {
                options.IncludeXmlComments(name);
            }
        });
        // Add framework services.
        services.AddMvc();
    }

这是一个正确显示的示例:

http://swashbuckletest.azurewebsites.net/swagger/ui/index?filter=TestEnum#/TestEnum/TestEnum_Put

其背后的代码在 GitHub 上:

https://github.com/heldersepu/SwashbuckleTest/blob/master/Swagger_Test/Models/ViewModelTest.cs