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

时间:2016-03-07 06:35:15

标签: c# documentation xmldocument asp.net-web-api-helppages

enter image description here

我已阅读here有关网址API帮助页面的其他信息。数据注释实际上提供了文档的附加信息。但我想知道,无论如何都要提供没有数据注释的附加信息吗?

如果是,那么如何?

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

[Required]

显示需要写入附加信息,但如果我想显示"该字段是必需的"或类似的东西?

由于

编辑参见图片我希望在没有数据注释的情况下更新其他信息。

3 个答案:

答案 0 :(得分:3)

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

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"})

基本上,当必需属性启动时,您将为ASP.Net填充验证消息添加一个字段。

答案 1 :(得分:2)

您可以修改Required AttributeModelDescriptionGenerator.csAreas>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);
        }

see

答案 2 :(得分:1)

如果你想提供自定义的附加信息(使用数据注释),那么@Pedro G. Dias的答案就是你的解决方案,但如果你想在不使用数据注释的情况下提供额外的信息,那么我担心这是不可能的,或者你有在你的问题上使用@DynamicVariable评论的一些替代程序。

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