Question

我已经为我的web api 2项目创建了一个帮助区域文档（基于owin / katana）。我打开了配置中的所有设置并安装了Microsoft.AspNet.WebApi.OData。目前我有以下设置：

config.SetSampleObjects(new Dictionary<Type, object>
{
    {typeof(string), "sample string"},
    {typeof(IEnumerable<string>), new string[]{"sample 1", "sample 2"}}
});

config.SetSampleForMediaType(
    new TextSample("Binary JSON content. See http://bsonspec.org for details."),
    new MediaTypeHeaderValue("application/bson"));

config.SetSampleForType("[0]=foo&[1]=bar", new MediaTypeHeaderValue("application/x-www-form-urlencoded"), typeof(IEnumerable<string>));

config.SetSampleRequest("1234", new MediaTypeHeaderValue("text/plain"), "Values", "Put");

config.SetSampleResponse(new ImageSample("../images/aspNetHome.png"), new MediaTypeHeaderValue("image/png"), "Values", "Get", "id");

config.SetActualRequestType(typeof(string), "Values", "Get");

config.SetActualResponseType(typeof(string), "Values", "Post");

但是，我没有生成任何响应样本。我的页面看起来像我在网上看到的那样

但它像这样松散。如何显示样本响应格式，如第一张图片中所示的JSON？

Answer 1

尝试使用ResponseType属性修饰控制器操作，如下所示：

    [HttpGet]
    [Route("enterprise/")]
    [ResponseType(typeof(EnterpriseViewModel))]
    public IHttpActionResult Get()
    {
        ...
    }

如果你有一个带有参数的构造函数，你还必须在ViewModel类中提供一个空白构造函数。

Answer 2

这是因为内容协商。您可能在回复中指定了类似的内容：

config.SetSampleForType("[0]=foo&[1]=bar", new MediaTypeHeaderValue("application/x-www-form-urlencoded"), typeof(IEnumerable<string>))

这会阻止内容协商正常工作，因此，帮助页面中未生成任何JSON格式。

更多信息：http://blogs.msdn.com/b/yaohuang1/archive/2012/10/13/asp-net-web-api-help-page-part-2-providing-custom-samples-on-the-help-page.aspx

生成的WEB API帮助区文档不显示响应正文格式/示例

2 个答案: