http - Web API 帮助示例 - C#

Question

ASP.NET Web API 有一个易于安装的带有示例生成器的 Nuget 帮助页面。让它生成和显示示例请求很容易，但让它显示示例响应 (httpsampresponses) 似乎并不那么容易，这样当开发人员查看帮助页面时，他们会看到生成的响应示例/不是静态的/类型化的在响应中，但实际生成。我以前在另一个项目上看到过它，但仍然无法弄清楚如何去做。 MSDN's YAO has a good blog但出于某种原因，它并没有让我一路走向成功。

根据我所看到的实时工作以及在线阅读的内容，这绝对是根据 config.SetSampleResponses() 设置正确获取 HelpPageConfig 文件。我发现了为 SetSampleResponses() 方法设置参数的配置文件，但我仍然没有尝试任何工作。有人向我建议我应该创建一个自定义类型并使用扩展方法，但是让它对应并显示我需要的东西还没有发生。我可以正确编译它，但它仍然没有在页面上显示生成的响应示例。使用 SetSampleForType 片段很容易在请求部分中显示一个部分，但给我带来麻烦的是响应部分。

有没有人成功地使用 SetSampleResponses() 完成了此操作？是否有任何类型的技巧可以明确定义以使其正常工作？关于设置特定的通用类型并使其工作，您有什么技巧吗？

我想这一定是一件非常简单的事情，我只是没有点击让它发生......

感谢您提供任何可能的信息...

Answer 1

HelpPageConfig 上的 SetSampleResponse 扩展用于为您的操作静态定义示例。

config.SetSampleResponse("\"Hello World!\"", new MediaTypeHeaderValue("application/json"), "Values", "Get", "id");

如果您正在寻找为特定类型生成的样本，您是否尝试过使用 SetSampleObjects 扩展，它允许您为不同类型设置样本对象，并且在从操作返回该特定类型的所有情况下都使用相同的对象。

config.SetSampleObjects(new Dictionary<Type, object>
        {
            {typeof(string), "Hello World!"}
        });

您能否分享有关如何使用 SetSampleResponse 扩展的更具体(代码)的详细信息？