C# Webapi HelpPage 请求模型自定义答案

【问题标题】：C# Webapi HelpPage Request Model CustomizationC# Webapi HelpPage 请求模型自定义
【发布时间】：2014-02-17 08:30:56
【问题描述】：

我已经使用 HelpPage 创建了我的 WebAPI 控制器的文档。我的网络 api 中有以下模型。

public class InfoModel
{
    [Required]
    public int id { get; set; }

    [Required]
    public string title { get; set; }

    public string status { get; set; }

    public string created_at { get; set; }
}

HelpPage 在帮助页面上呈现 InfoModel，如下所示：

{
   "id": 1,
   "title": "Sample string 2",
   "status": "Sample string 3",
   "created_at": "Sample string 4"
}

使用来自Model Validation 的 [Required] 属性，我想突出显示具有 [Required] 属性的属性。如何将 HelpPage MVC 插件自定义为粗体“id”和“title”，以便用户知道这些属性是REQUIRED：

{

“id”：1，

"title": "示例字符串 2",

"status": "示例字符串 3",

"created_at": "示例字符串 4"

}

我了解 Jquery/CSS，但是对于那个 HelpPage MVC 应该渲染 HTML 内容，并为 [Required] 属性添加一些标记，以便 JS/CSS 可以在客户端以不同的方式设置它们。我期待在 Areas.HelpPage.ObjectGenerator 类中进行一些修改，该类负责为 InfoModel 生成 HTML。

【问题讨论】：

应用一些CSS？字体粗细：粗体；
将 CSS 应用于什么？我的意思是如何让 CSS 知道区分必需参数和可选参数？
您必须定义哪些参数是必需的和可选的。
@theGeekster Sam 的意思是（尽管它很模糊）是 HelpPages 只是像 MVC 项目中的任何其他视图一样写出 Razor 视图。查看在您的Areas/HelpPage 文件夹中生成的Index.cshtml 以查看生成的DOM 结构-然后包含您可能需要的任何CSS。如前所述，您可能需要 jQuery 来根据 API 列表的文本内容添加类
我在上面添加了我的示例 InfoModel 类代码，它用 [Required] 属性注释关键参数。这就是我想以某种方式在 HelpPage 上显示的内容，以让用户知道这些参数是 [必需的]。我了解 Jquery/CSS，但对于那个 HelpPage MVC 应该渲染 HTML 内容并带有一些标记 [Required] 属性，以便 JS/CSS 可以在客户端以不同的方式设置它们。我期待在负责为 InfoModel 生成 HTML 的 Areas.HelpPage.ObjectGenerator 类中进行一些修改。

标签： c# model request customization asp.net-web-api-helppages

【解决方案1】：

如果您使用的是最新版本的 Web API，那么您将获得有关 Required 等数据注释属性的有用信息。

示例：

【讨论】：

这到底是什么版本？ Web API 是指最新的 HelpPage 还是什么？

【解决方案2】：

使用jQuery 将css 应用到id 和title：

$('foo').css("font-weight","Bold");

【讨论】：