Quelle: dotnetpro
web api mit OpenAPI 18.10.2021, 00:00 Uhr

Neuer Landeplatz

Das neue Template für ASP.NET Core Web API zeigt in Visual Studio gleich das Swagger-UI an.
Web-API-Anwendungen sind eigentlich klassische MVC-Anwendungen. Startet man sie in Visual Studio, wird automatisch ein Browserfenster geöffnet, das die Startseite der Anwendung anzeigen soll. Doch welche ist das bei einer Anwendung, die ja eigentlich kein UI besitzt? In der Vergangenheit wurden dazu die Beispielimplementierungen von Klassen wie ValuesController oder WeatherForecastController herangezogen. Diese wird man in realen Projekten aber gleich zu Anfang löschen – und dann? Dann steht vielleicht gar keine Controller-Methode zur Verfügung, die sich direkt im Browser aufrufen ließe, oder es ergibt im Kontext der Anwendung einfach keinen Sinn, eine auszuwählen. Somit läuft der Browser-Start oft ins Leere.
Swagger beziehungsweise OpenAPI für die Dokumenta­tion des eigenen Web API einzusetzen ist nicht neu, dotnetpro hat bereits darüber berichtet [1]. Nur musste man bislang die wenigen notwendigen Aufrufe im Startup-Code der Anwendung selbst umsetzen und bei Bedarf das Swagger-UI selbst als Startseite vorgeben. Das ist jetzt bereits als Voreinstellung vorgesehen beziehungsweise lässt sich mit dem neuen Template in Visual Studio mit einem Klick beim Anlegen eines neuen Web-API-Projekts erledigen (Bild 1). Startet man die gerade angelegte Anwendung, sieht man nicht mehr Demo-Daten im JSON-Format, sondern das Swagger-UI mit der Darstellung aller implementierten öffentlichen Dienste (Bild 2).

Jetzt 1 Monat kostenlos testen!

Sie wollen zukünftig auch von den Vorteilen eines plus-Abos profitieren? Werden Sie jetzt dotnetpro-plus-Kunde.
  • + Digitales Kundenkonto,
  • + Zugriff auf das digitale Heft,
  • + Zugang zum digitalen Heftarchiv,
  • + Auf Wunsch: Weekly Newsletter,
  • + Sämtliche Codebeispiele im digitalen Heftarchiv verfügbar