Dokumentacja umożliwiającym integrację xmldoc do swoich projektów WWW interfejsu API pojawia się tylko do sytuacji, w której uchwyt wszystkich typów API są częścią projektu WebAPI. W szczególności omawia, jak przekierować dokumentację XML do App_Data/XmlDocument.xml
i odkomentować wiersz w konfiguracji, który będzie zużywał ten plik. To niejawnie zezwala tylko na jeden plik dokumentacji projektu.
Jednak w mojej konfiguracji typy żądań i odpowiedzi są zdefiniowane we wspólnym projekcie „Modele”. Oznacza to, że jeśli mam zdefiniowany punkt końcowy, taki jak:
[Route("auth/openid/login")]
public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { ... }
Where OpenIdLoginRequest
jest zdefiniowany w oddzielnym projekcie C #, jak na przykład:
public class OpenIdLoginRequest
{
/// <summary>
/// Represents the OpenId provider that authenticated the user. (i.e. Facebook, Google, etc.)
/// </summary>
[Required]
public string Provider { get; set; }
...
}
Pomimo dokumentów XML, właściwości request
parametru nie zawierają dokumentacji podczas przeglądania strony pomocy specyficznej dla punktu końcowego (tj http://localhost/Help/Api/POST-auth-openid-login
.).
Jak sprawić, by typy w podprojektach z dokumentacją XML pojawiały się w dokumentacji XML interfejsu API sieci Web?
źródło
var files...
wierszavar files = Directory.GetFiles(documentPath, "*.xml");
jeśli (tak jak ja) nie zawsze będziesz znać nazwy / liczbę plików dokumentacji xml, które tam będą. W razie potrzeby można też przeprowadzić dalsze filtrowanie.Też napotkałem to, ale nie chciałem edytować ani powielać żadnego z wygenerowanego kodu, aby później uniknąć problemów.
Opierając się na innych odpowiedziach, oto niezależny dostawca dokumentacji dla wielu źródeł XML. Po prostu wrzuć to do swojego projektu:
... i włącz go w swoim
HelpPageConfig
ze ścieżkami do żądanych dokumentów XML:źródło
Jeszcze jednym uproszczonym sposobem jest scalenie plików xml. Przykładowy kod w mojej poniższej odpowiedzi:
Komentarze XML strony pomocy interfejsu API sieci Web z więcej niż 1 plików
źródło
tutaj podaję link z odpowiedzią, który może ci pomóc. Możesz łatwo użyć wielu plików XML do dokumentacji.
Komentarze XML strony pomocy interfejsu API sieci Web z więcej niż 1 plików
źródło
Najłatwiejszym sposobem rozwiązania tego problemu jest utworzenie folderu App_Code na wdrożonym serwerze. Następnie skopiuj XmlDocument.xml, który masz w folderze bin lokalnie do folderu App_Code
źródło