Zusammenfassung
Eine ausführliche Dokumentation für eine API vereinfacht die Nutzung und Verwaltung der API. Im Beispiel dieses Moduls haben Sie Swashbuckle und Swagger verwendet, um automatisch eine OpenAPI-Dokumentation für Ihre ASP.NET Core-API zu erstellen.
Wenn Sie Swashbuckle-Pakete zu Ihrem Projekt hinzufügen, erhalten Sie eine professionelle OpenAPI-Dokumentation. Swagger UI vereinfacht die Lesbarkeit der OpenAPI-Dokumentation, und der Kunde muss den Quellcode der API nicht kennen.
Sie haben ebenfalls erfahren, wie die Standarddokumentation zu Swagger mithilfe von XML-Kommentaren und -Anmerkungen verbessert werden kann.