Interaktive Dokumentation und Proxies für Web-APIs mit Swagger 19.01.2017, 00:00 Uhr

Wer schreibt, der bleibt

Wie Sie ein Swagger-Dokument für ein auf ASP.NET Core 1 basierendes Web-API ­generieren, lesen Sie hier. Und welche Rolle Swashbuckle dabei spielt.
Sprachen zum Beschreiben serverseitiger Dienste sind fast so alt wie die Geschichte verteilter Systeme. Ein populäres Beispiel dafür ist die Web Services Description Language (WSDL), welche SOAP-basierte Web Services samt Operationen, ein- und ausgehenden Nachrichten sowie Protokolldetails dokumentiert. Da die Beschreibung auf formale Weise erfolgt, bieten sich solche Technologien für das automatische Erzeugen von Quellcode an. Gerade das Generieren von Proxies, die die Details der Netzwerkkommunikation verstecken und dem Client komfortable Aufrufmöglichkeiten geben, ist ein beliebter Anwendungsfall dafür.
Für Web-APIs gibt es jedoch keinen offiziellen Standard hierzu. Allerdings liegt mit Swagger [1] eine sehr populäre Lösung vor, die den Stellenwert eines De-facto-Standards genießt. Man findet für so gut wie jede Plattform Swagger-Implementierungen, welche Swagger-Dokumente generieren und auf deren Basis Proxies erstellen.

dotnetpro

Sie wollen zukünftig auch von den Vorteilen eines plus-Abos profitieren? Werden Sie jetzt dotnetpro-plus-Kunde
  • 2 Monate Gratis testen
  • Über 4.000 qualifizierte Fachartikel
  • Auf jedem Gerät verfügbar