Swagger C#数据注解:参数字段中的占位符

ryoqjall  于 2022-11-06  发布在  C#
关注(0)|答案(1)|浏览(227)

除了使用DefaultValue预填充之外,是否有方法将占位符值添加到文档中?
编辑:以下将产生

public ActionResult TestGet(
    [DefaultValue("hello world")]
    string test) => Ok();


但是当选择“尝试"时,它也会预先填充该测试。我希望能够给予一个描述来代替灰色文本,这些文本一旦被键入就不会出现(占位符文本)。这是可以在HTML输入组件中完成的事情。

b1zrtrql

b1zrtrql1#

您可以使用xml注解:
步骤1:将xml注解添加到方法中,如下所示:remove default value

/// <summary>
    /// TestGet
    /// </summary>
    /// <param name="test">Enter your input here</param>
    /// <returns></returns>
    [HttpGet]
    [Route("TestGet")]
    public ActionResult TestGet(string test) => Ok();

第二步:在项目设置中启用单据生成。

第三步:告诉swagger包含xml注解。

builder.Services.AddSwaggerGen(c =>
{
    c.IncludeXmlComments(Path.Combine(
                    Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location),
                    $"WebApplication1.xml"));
});

结果:你可以用描述来写任何你想写的东西。

相关问题