Früher habe ich WebAPI genutzt, um Schnittstellen im Projekt bereitzustellen, und festgestellt, dass im Projekt automatisch Hilfedokumente gemäß Webapi-Methoden und Kommentaren generiert werden, und man kann Webapi-Methoden testen, die sehr leistungsstark sind, und jetzt werde ich sie mit Ihnen teilen.
Schau dir zuerst die generierte Webapi-Dokumentation an.
1. Die folgende Abbildung zeigt die oberste Seite des Generierungshilfedokuments, wobei Values der Controller ist und die Liste unter der API die HTTP-Methode (Get, POST usw.), die Aktion der Anfrage und die Beschreibung der Methode darstellt.
2. Klicken Sie auf den Link im roten Feld, um die Detailseite der API-Methode zu öffnen, wie in der untenstehenden Abbildung gezeigt.
3. Klicke auf Test API, um die folgende Seite zu öffnen
4. Geben Sie die Parameter ein, klicken Sie auf die Schaltfläche Senden, öffnen Sie die folgende Seite, und Sie sehen den Rückgabewert.
Die Schritte zur Einrichtung sind wie folgt:
Entwicklungsumgebung VS2012 + MVC4 + WEB API
1. Referenz auf den Web-API-Testclient über NuGet
Das Referenzieren der DLL erzeugt eine Datei wie diese:
Dies ist unsere Benutzeroberfläche zur Hilfedokumentation
2. Nehmen Sie die folgenden Einstellungen in den Projekteigenschaften vor, überprüfen Sie die XMl-Dokumentdatei und legen Sie den Pfad fest
3. Erstelle ein XmlDocument.xml unter dem App_Data-Ordner des Projekts
4. Öffnen Sie die AreasHelpPageApp_StartHelpPageConfig.cs-Datei und kündigen Sie die folgenden Code-Kommentare
Führe das Projekt aus, öffne die http://localhost:3619/Help, und du siehst das automatisch generierte API-Dokument, das ein Bild des Artikels ist
Projektdownload:
Veröffentlicht am 06.10.2016 15:08:16
|
|
|
|
