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

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 属性装饰您的 Controller 操作，如下所示:

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

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