REST Service Projekt mit Swagger in Visual Studio 2019
Um ein Visual Studio 2019 REST Service Projekt mit Swagger zu erstellen kann folgendermassen vorgegangen werden:
- Erstellen eines "ASP.NET Web Application (.NET Framework)" oder Core Projekts, "Web API" Template auswählen.
- Nuget Pakete aktualisieren (mehrfach durchführen, bis keine Updates mehr verfügbar)
- Swagger Nuget Paket "SwashBuckle.Net45" hinzufügen
- In den Projekt Einstellungen unter "Build" "XML documentation file" aktivieren
- Im Swagger Konfigurationsfile "\App_Start\SwaggerConfig.cs" folgende Methode einfügen:
- protected static string GetXmlCommentsPath()
- {
- return System.String.Format(@"{0}\bin\SubscriptionLogRestService.xml",
- System.AppDomain.CurrentDomain.BaseDirectory);
- }
- Im Swagger Konfigurationsfile "\App_Start\SwaggerConfig.cs" die Zeile "c.IncludeXmlComments(GetXmlCommentsPath());" auskommentieren, sodass die XML Kommentare im Swagger UI erscheinen
Methodenkommentare sollten folgendermassen aussehen:
/// <summary> /// Returns a group of Employees matching the given first and last names. /// </summary> /// <remarks> /// Here is a sample remarks placeholder. /// </remarks> /// <param name="firstName">The first name to search for</param> /// <param name="lastName">The last name to search for</param> /// <returns>A string status</returns>