C# Web帮助文档IHttpActionResult

Question

我有一个C# Web，我正在尝试让自动创建的帮助文档与IHttpActionResult一起工作。我简化了下面的示例，这样读起来就容易了一些。

对于对象，下面是一个简单的示例。BusinessObject只是一个包装器。CollectionBase是CollectionBase : ObservableCollection<T>, ILoadable where T : BusinessObject。它是一个较旧的代码库，它是自动生成的，但为此而重用它。

    public class Value : BusinessObject
    {
        public int Id { get; set; }
    }
    public class Values : CollectionBase<Value>
    {
        public override Value LoadObject(System.Data.IDataRecord record)
        {
            return new Value();
        }
    }

用于API方面的内容。下面的工作。

public class Values : ApiController
{
    public IEnumerable<Value> GetThis()
    {
        Values values = new Values();
        return values;
    }
}

​

​

当我尝试去做的时候，问题就来了

    public IHttpActionResult GetThis()
    {
        Values values = new Values();
        return Ok(values);
    }

它不认识到它应该使用不同的返回类型。“资源描述”最后是没有示例输出的IHttpActionResult。现在我可以加上

config.SetActualResponseType(typeof(IEnumerable<Value>), "Values", "GetThis");

它将显示一个示例输出，但“资源描述”仍然是IHttpActionResult。这是我目前面临的主要问题。我想使用IHttpActionResult，因为它非常容易使用，如果需要的话可以返回错误代码。我只想能够自动构造文档。

更新：经过进一步的研究，我对这篇文章做得很好。Resource Description on Web API Help page is showing "None."

基本上，可以将响应类型属性添加到方法中。

[ResponseType(typeof(IEnumerable<Value>))]
public IHttpActionResult GetThis()
{
    Values values = new Values();
    return Ok(values);
}

虽然这在技术上是可行的，而且我已经修改了我现有的代码来使用它。如果有一种方法能让它自动解决，那还是很好的。不确定这是否可能。

Answer 1

这对我正在做的事情很有用。每次都需要包含一些繁琐的内容，但它允许我在必要时返回错误代码，并保留帮助文档功能。

[ResponseType(typeof(IEnumerable<Value>))]
public IHttpActionResult GetThis()
{
    Values values = new Values();
    return Ok(values);
}

Resource Description on Web API Help page is showing "None."