WebAPI 2 yardım dökümanlarını kırmayan geri dönüş türleri Web sitesi

Question

Süper kullanışlı yardım belgelerini kesmeden API yöntemlerim için (görünüşte tercih edilen) IHttpActionResult dönüş türünü kullanmanın bir yolu var mı? Yöntemimden List<T> 'u döndürdüğümde, çok açıklayıcı yardım belgeleri alırım. IHttpActionResult'u geri döndüğümde, işe yaramaz yardım belgelerini alıyorum. Neden böyle havalı bir oyuncak verelim ve sonra oyuncağı kıran bir şey kullandığımızı mı öneriyoruz? MS tercih edilen stili ile birlikte dokümantasyon web sitesini nasıl kullanacağım için mükemmel bir kaynak eksik miyim?

Answer 1

HttpResponseMessage veya IHttpActionResult kullanırken, beklenen dönüş türünü belirten eylem yöntemlerinizi ResponseTypeAttribute ekleyebilmeniz gerekir. Bu, belgeleri oluşturduğunda ApiExplorer tarafından alınmalıdır. web sitesinden

: beyan döndürme türü HttpResponseMessage veya IHttpActionResult olduğunda

bunu kullanın bir eylem tarafından döndürülen varlık türünü belirtmek için. ResponseType, ApiDescription'ı oluştururken ApiExplorer tarafından okunacaktır.

onlar bunu destekleyecek veya söz konusu dahil ve belki birisi burada elini biliyorsa size kontrol etmelisiniz belgeleri oluşturmak için başka API kullanıyorsanız.