c# - API 文档中的自定义附加信息

Question

我在这里阅读了有关 Web API 帮助页面的附加信息。数据注释实际上为文档提供了附加信息。但我想知道是否有提供额外信息而无需数据注释？

如果是，那怎么办？

如果没有，那么无论如何都要用数据注释覆盖附加信息，例如

[Required]

显示需要写在附加信息中，但是如果我想显示“此字段是必需的”或类似的内容怎么办？

谢谢

编辑如图所示，如果可能的话，我想在没有数据注释的情况下更新附加信息。

score 3 · Accepted Answer

因此注释允许您进一步指定要求，即如果您有以下模型：

public class MyModel {

    [Required(ErrorMessage = "You seriously need a name here bro")]
    public string Name{ get; set; }

}

然后，您可以自动在 ASP.Net 页面中显示验证消息，如下所示：

@model string
@Html.TextBoxFor(m => m)
@Html.ValidationMessageFor(model => model, "", new { @class = "text-danger"})

因此，基本上，您为验证消息添加一个字段，当Required属性启动时，该字段将由 ASP.Net 填充。

score 3 · Accepted Answer

您可以 Required Attribute 在ModelDescriptionGenerator.cs
Areas>HelpPage>ModelDescriptions>ModelDescriptionGenerator.cs
例如：

    [Required(ErrorMessage ="Must pass")]
    public string Name { get; set; }

我得到：附加信息：必须通过

代替：

 { typeof(RequiredAttribute), a => "Required" }

和：

{ typeof(RequiredAttribute), a => {
            RequiredAttribute b =(RequiredAttribute)a;
            return (b.ErrorMessage);
        }

score 2 · Accepted Answer

如果您想提供自定义附加信息（使用数据注释），那么@Pedro G. Dias 的答案是您的解决方案，但是如果您想在不使用数据注释的情况下提供附加信息，那么恐怕这是不可能的，或者您必须使用一些@DynamicVariable 对您的问题所评论的替代程序。

PS。我调试了文档项目进行检查，发现添加信息实际上是由数据注释提供的。

3 回答 3