Asp.Net Web API Dokumentation Tools zur Unterstützung der Beschreibung bearbeiten

Question

Ich bin auf der Suche nach einem Dokumentations-Tool oder Generator für ASP.net Web-API-Anwendung. Das Tool muss erlauben, die Beschreibung/Zusammenfassung der API-Methoden oder -Parameter zu bearbeiten. Ich brauche das vielleicht, damit verschiedene Teams sagen, PMs, QA, auch die Dokumentation zu bearbeiten, so dass es nicht immer Entwickler sein muss.

Bitte schlagen Sie alle guten Werkzeuge vor, die diese Anforderung unterstützen.

Answer 1

Wir haben Swagger verwendet, um unsere APIs zu dokumentieren. Dieses Nuget-Paket Swashbuckle fügt Swagger zu Ihrem API-Projekt hinzu. https://github.com/domaindrivendev/Swashbuckle

Die Dokumentation wird mit XML-Kommentaren erstellt und in einer benutzerfreundlichen Benutzeroberfläche angezeigt, mit der Sie sogar Ihre APIs testen können.

Answer 2

Danke für die Antwort. Ich stimme dir zu.

Jetzt suche ich nach Tool für Online-Dokumentation, die aus meinem bestehenden XML-Dokument generiert. Diese Online-Dokumentation könnte von Teammitgliedern weiter bearbeitet und veröffentlicht werden können.