Web API Hilfe-Seite nicht XML zeigt

Question

Ich habe ein Web-API-Projekt, in dem ich von Hand entfernt Bereiche Ordner vor einigen Monaten, wenn wir die Entwicklung begonnen. Jetzt, nachdem alles fertig ist, möchte ich API-Hilfeseiten hinzufügen, aber es funktioniert nicht wie erwartet.

Ich habe nuget-Paket für Hilfeseiten installiert.

ich unkommentiert Linie in HelpPageConfig.cs

geprüft I Dokumentation Datei generieren (auf Ordner App_Data)

Wenn ich öffnen http://localhost:51665/help ich diese: (keine Methoden werden gezeigt)

Irgendeine Idee, was könnte falsch sein? Wenn ich ein neues Projekt von Grund auf neu starte, funktioniert alles einwandfrei.

Answer 1

Ich nehme an, Sie haben Setup-Projekt in zwei Schritten:

1. Sie sollten Registerkarte in API Projekt Eigenschaften und einrichten XML-Dokumentationsdatei in Output Abschnitt Erstellen wählen. Zum Beispiel: App_Data\XmlDocument.xml
2. Dann können Sie HelpPageConfig.cs in Methode Register ... in meinem Fall aktualisieren

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

• Wenn Ihr Projekt ist in Kompilierungsvorgang, werfen Sie einen Blick in Ausgabefenster, ob Dokumentation wird wirklich generiert.

• Versuchen ältere Version von ASP.NET Hilfeseiten (Version 5.2.2 funktioniert für mich) zu verwenden.

  Install-Package Microsoft.AspNet.WebApi.HelpPage -Version 5.2.2