Pomoc ASP.NET Web API Dokumentacja strony przy użyciu komentarzy Xml na kontrolerach

Question

Zainstalowałem pakiet ASP.NET Web API Help Page i chciałbym go użyć do wygenerowania dokumentacji dla moich działań kontrolera API przy użyciu komentarzy Xml już na nich.

Natknąłem się na article on Yao's MSDN blog, gdzie omawia sposób generowania dokumentacji na podstawie komentarzy XML.

Jednak w metodzie Register of HelpPageConfig, metoda SetDocumentationProvider oczekuje wystąpienia obiektu XmlDocumentationProvider zbudowanego z fizyczną ścieżką do pliku dokumentacji Xml.

Czy jest inny sposób na zrobienie tego? Nie wiem, dlaczego muszę wskazać plik dokumentacji Xml.

Dzięki

Answer 1

XmlDocumentationProvider szuka pliku xml (posiadające swoje komentarze kodu XML), który pobiera generowane podczas kompilacji projektu. Możesz włączyć generowanie tego przechodząc do projektu Właściwości -> Kompilacja -> Dane wyjściowe. Tutaj zaznacz pole wyboru Dokumentacja XML.

Answer 2

Jeśli problem nadal występuje, patrz poniżej.

Krok 1 - Dodaj komentarz na poziomie kontrolera

// GET api/documentation 
/// <summary> 
/// This is how we create a documentation 
/// </summary> 
/// <returns></returns> 
public IEnumerable<string> Get() 

Krok 2 - Budowanie właściwości właściwości projektu strony i ustawić wyjście xml dla dokumentacji

Krok 3 - pomoc w konfiguracji strony

Aby skonfigurować HelpPageConfig do korzystania z pliku dokumentacji xml, przejdź do strony ~\Areas\HelpPage\HelpPageConfig.cs.

Domyślnie instrukcja config.SetDocumentationProvider została zakomentowana. Użyj tego oświadczenia oraz wskazać lokalizację DocumentationProvider do naszego pliku XML:

public static void Register(HttpConfiguration config) 
{ 
    // Uncomment the following to use the documentation from XML documentation file. 
    config.SetDocumentationProvider(
      new XmlDocumentationProvider(
       HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml"))); 
} 

EDIT:

Położenie HelpPageConfig w nowym Web API 2.2 projektu utworzonego w VS2013 jest ~\Areas\HelpPage\App_Start\HelpPageConfig.cs

Answer 3

Wiem, że to pytanie zostało odebrane, ale na wypadek, gdyby pomogło komuś Znalazłem tę stronę, ponieważ szukałem rozwiązania dla dokumentacji dla IHttpActionResult

How to add IHttpActionResult into documentation