如何覆盖 Swagger for .Net Core Web Api 中的描述 'No parameters'？

Question

在 .Net Core Web Api 项目中，我有 Get 不需要传递请求数据。默认情况下，SwaggerUi 在“参数”选项卡下生成 'No parameters' 描述。见下文。

我的目标是用其他东西替换 'No parameters' 字符串。我想添加额外的信息，为什么不需要参数。如果可以的话，请分享一个知识。

Answer 1

找了半天也没有找到修改参数自定义内容的方法，不过你可以在url上添加你需要的备注，像这样：

要启用 XML 评论，我们需要执行以下步骤：

1.In 项目属性的构建选项卡，选中标记为 XML 文档文件的框。让我们保留 auto-generated 文件路径。

2.Suppress 警告 1591，现在将针对任何方法、class 或没有 triple-slash 注释的字段发出警告。

在 ConfigureServices() 方法中，将 Swagger 配置为使用在上述步骤中生成的 XML 文件：

public void ConfigureServices(IServiceCollection services)
{
    // Register the Swagger generator, defining 1 or more Swagger documents
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
       //......TODO

// Set the comments path for the Swagger JSON and UI.
        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
        c.IncludeXmlComments(xmlPath);
    });

现在，通过向 header.

部分添加描述，向操作方法添加 triple-slash 注释可增强 Swagger UI

 /// <summary>
        /// This is test    
        /// </summary>
        /// 
        /// 
       [Route("test")]
       [HttpGet]
        public string Test()
        {
            return "v1 test";
        }

结果：

如何覆盖 Swagger for .Net Core Web Api 中的描述 'No parameters'？

How to override description 'No parameters' in Swagger for .Net Core Web Api?

c#

swagger

asp.net-core-webapi

swagger-ui