2018年6月20日 星期三

Swashbuckle (2) 利用設定 ResponseType 告知 swagger 實際上回傳的型別為何

當 api 回傳的型別是 IHttpActionResult 時,利用設定 ResponseType
告知 swagger 實際上回傳的型別為何。

環境:vs2017、.net framework 4.7、Swashbuckle 5.6.0

透過 ResponseType 屬性,控制 Swagger 頁面所顯示的資訊

WebApi 的內容

//ResponseType 的 namespace 是 System.Web.Http.Description

using System.Web.Http.Description;

public class ValuesController : ApiController {
  [ResponseType(typeof(Person))]
  public IHttpActionResult Get(string id)
  {
    return Ok(new Person());
  }
}

加上 [ResponseType(typeof(Person))] 前後的比對,可以透過 Model 和 Example Value 的切換
切換樣本和回傳的 Model 的定義。



沒有留言:

張貼留言