C# 使用Microsoft.AspNet.WebApi.HelpPage添加JSON示例

C# 使用Microsoft.AspNet.WebApi.HelpPage添加JSON示例,c#,asp.net-web-api,C#,Asp.net Web Api,我已经使用Microsoft.AspNet.WebApi.HelpPage和C#XML注释为我的Web API项目生成了Web API文档,但我想为每个方法添加JSON示例,但不知道如何添加 下面是我的方法的XML注释: /// <summary> /// Gets data values for a given data key. /// </summary> /// <param name="mas

我已经使用Microsoft.AspNet.WebApi.HelpPage和C#XML注释为我的Web API项目生成了Web API文档,但我想为每个方法添加JSON示例,但不知道如何添加

下面是我的方法的XML注释:

        /// <summary>
        /// Gets data values for a given data key.
        /// </summary>
        /// <param name="masterAgencyID">The MasterAgencyDivisionID for the desired values.</param>
        /// <param name="masterClientID">The MasterClientID for the desired values.</param>
        /// <param name="dataKeyCode">The DataKey's code for which values are to be returned.</param>
        /// <returns>An object containing two lists: IncludedValues and ExcludedValues.</returns>
        /// <example>
        /// {
        ///     "IncludedValues": [
        ///         {
        ///             "DataValueID": 644,
        ///             "DataValueCode": "1000X500",
        ///             "DataValueShortDescr": "1000X500",
        ///             "excluded": false
        ///         },
        ///         ...
        ///     ],
        ///     "ExcludedValues": [
        ///         {
        ///             "DataValueID": 644,
        ///             "DataValueCode": "1000X500",
        ///             "DataValueShortDescr": "1000X500",
        ///             "excluded": true
        ///         },
        ///         ...
        ///     ]   
        /// </example>
//
///获取给定数据键的数据值。
/// 
///所需值的MasterAgencyDivisionID。
///所需值的MasterClientID。
///要为其返回值的数据键代码。
///包含两个列表的对象:IncludedValues和ExcludedValues。
/// 
/// {
///“IncludedValues”:[
///         {
///“DataValueID”:644,
///“DataValueCode”:“1000X500”,
///“DataValueShortDescr”:“1000X500”,
///“排除”:错误
///         },
///         ...
///     ],
///“排除价值”:[
///         {
///“DataValueID”:644,
///“DataValueCode”:“1000X500”,
///“DataValueShortDescr”:“1000X500”,
///“排除”:正确
///         },
///         ...
///     ]   
/// 
以下是为该方法生成的网页:

如您所见,在“示例:”下,页面显示“示例不可用”


它显然不是从XML标签中读取。要在API文档中包含一个示例,我必须做些什么?

我没有在Web API中使用内置API文档,但您确定它就是这样工作的吗?我想它会根据您的对象名/类型创建一个通用JSON对象。您能链接到显示u的文档吗在XML注释中使用
会产生这种行为?可能只是一种误解。我假设您使用
/doc
正确编译了文档。要在
标记中添加代码,您需要使用
标记。这是相关的。@MarkC:是的,可能是这样,这就是我文章的重点:我正在寻找任何一个知道如何填充样本的人:。嗨@rothkko,你明白了吗?我正试图做和你完全一样的事情。