C#Web API帮助文档IHttpActionResult

前端之家收集整理的这篇文章主要介绍了C#Web API帮助文档IHttpActionResult前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我有一个C#Web API,我试图获得自动创建的帮助文档以使用IHttpActionResult.我删除了下面的例子,以便它更容易阅读.

对于对象,下面是一个简单的例子. BusinessObject只是一个包装. CollectionBase是CollectionBase:ObservableCollection< T>,ILoadable其中T:BusinessObject.它是一个旧的代码库,它是自动生成的,但重用它.

  1. public class Value : BusinessObject
  2. {
  3. public int Id { get; set; }
  4. }
  5. public class Values : CollectionBase<Value>
  6. {
  7. public override Value LoadObject(System.Data.IDataRecord record)
  8. {
  9. return new Value();
  10. }
  11. }

对于API方面的事情以下作品.

  1. public class Values : ApiController
  2. {
  3. public IEnumerable<Value> GetThis()
  4. {
  5. Values values = new Values();
  6. return values;
  7. }
  8. }

当我尝试做的时候出现问题

  1. public IHttpActionResult GetThis()
  2. {
  3. Values values = new Values();
  4. return Ok(values);
  5. }

它不会识别它应该使用不同的返回类型. ‘资源描述’最终是IHttpActionResult,没有样本输出.现在我可以补充

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

它将显示示例输出,但“资源描述”仍将是IHttpActionResult.这是我遇到的主要问题.我想使用IHttpActionResult,因为它很容易使用,如果需要,可以很容易地返回错误代码.我只想自动构建文档.

更新:进一步的研究,我没有罚款这个职位.
Resource Description on Web API Help page is showing “None.”

勉强地,您将响应类型属性添加方法.

  1. [ResponseType(typeof(IEnumerable<Value>))]
  2. public IHttpActionResult GetThis()
  3. {
  4. Values values = new Values();
  5. return Ok(values);
  6. }

虽然这在技术上有用,我修改了我现有的代码来使用它.如果有办法让它自动将其弄清楚,那仍然会很好.不知道这是否可行.

解决方法

这适用于我正在做的事情.它有点乏味,必须包含每一次,但它允许我返回错误代码,并保留帮助文档功能.
  1. [ResponseType(typeof(IEnumerable<Value>))]
  2. public IHttpActionResult GetThis()
  3. {
  4. Values values = new Values();
  5. return Ok(values);
  6. }

Resource Description on Web API Help page is showing “None.”

猜你在找的C#相关文章