Swashbuckle扬鞭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); 
} 

为什么扬鞭UI不显示名称参数说明？

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